SQLfmt 使用教程

SQLfmt 使用教程

1. 项目的目录结构及介绍

SQLfmt 是一个用于格式化 SQL 代码的开源工具，其 GitHub 仓库地址为：https://github.com/jackc/sqlfmt。以下是 SQLfmt 项目的主要目录结构及其介绍：

sqlfmt/
├── .github/
│   └── workflows/
├── docs/
├── sqlfmt/
│   ├── __init__.py
│   ├── cli.py
│   ├── formatter.py
│   ├── parser.py
│   └── ...
├── tests/
│   ├── __init__.py
│   ├── test_cli.py
│   ├── test_formatter.py
│   └── ...
├── .gitignore
├── LICENSE
├── README.md
├── pyproject.toml
└── setup.py

• .github/workflows/: 包含 GitHub Actions 的工作流配置文件。
• docs/: 包含项目的文档文件。
• sqlfmt/: 包含 SQLfmt 的核心代码文件。
  • cli.py: 命令行接口的实现。
  • formatter.py: 格式化 SQL 代码的主要逻辑。
  • parser.py: SQL 解析器的实现。
• tests/: 包含项目的测试文件。
• .gitignore: Git 忽略文件的配置。
• LICENSE: 项目的开源许可证。
• README.md: 项目的介绍和使用说明。
• pyproject.toml: 项目的构建配置文件。
• setup.py: 项目的安装脚本。

2. 项目的启动文件介绍

SQLfmt 的启动文件是 sqlfmt/cli.py。这个文件包含了命令行接口的实现，用户可以通过命令行调用 SQLfmt 进行 SQL 代码的格式化。

# sqlfmt/cli.py
import argparse
import sys
from .formatter import format_string

def main():
    parser = argparse.ArgumentParser(description="SQLfmt: The autoformatter for dbt SQL")
    parser.add_argument("files", nargs="*", help="Files to format")
    parser.add_argument("--check", action="store_true", help="Check if files are formatted")
    parser.add_argument("--diff", action="store_true", help="Show diff of changes")
    parser.add_argument("--line-length", type=int, default=88, help="Desired line length")
    args = parser.parse_args()

    # 格式化逻辑
    for file in args.files:
        with open(file, "r") as f:
            sql_code = f.read()
        formatted_code = format_string(sql_code, line_length=args.line_length)
        # 处理格式化后的代码
        ...

if __name__ == "__main__":
    main()

3. 项目的配置文件介绍

SQLfmt 的配置文件主要是 pyproject.toml 和 .gitignore。

pyproject.toml

pyproject.toml 文件包含了项目的构建配置，例如依赖管理、构建工具等。

[tool.poetry]
name = "sqlfmt"
version = "0.1.0"
description = "SQLfmt: The autoformatter for dbt SQL"
authors = ["Jack Christensen <jack@example.com>"]
license = "MIT"

[tool.poetry.dependencies]
python = "^3.8"

[tool.poetry.dev-dependencies]
pytest = "^6.2"

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

.gitignore

.gitignore 文件用于指定 Git 版本控制系统中忽略的文件和目录。

# .gitignore
__pycache__/
*.pyc
*.pyo
*.egg-info/
dist/
build/
.env
.DS_Store

通过这些配置文件，用户可以更好地管理和构建 SQLfmt 项目。