prettier-plugin-sql-cst：SQL代码美化插件的安装与使用指南

---

项目目录结构及介绍

prettier-plugin-sql-cst 是一个专为 SQL 脚本设计的格式化插件，利用了 sql-parser-cst 进行解析，并遵循 Prettier 的格式化算法。该插件的仓库在 GitHub 上维护。以下是其基本的目录结构概述：

prettier-plugin-sql-cst/
├── src/                  # 源代码文件夹，包含了主要的处理逻辑。
│   └── ...               # 包含处理SQL格式化的核心逻辑文件。
├── test/                 # 测试文件夹，用于存放各种测试案例以确保插件功能。
│   └── ...               # 各种SQL格式化测试用例。
├── package.json          # 项目元数据文件，定义了依赖、脚本命令等。
├── README.md             # 项目的主要说明文档，包括使用方法和特性描述。
├── LICENSE               # 许可证文件，表明软件使用的许可类型（GPL-3.0）。
└── ...                   # 可能还包括其他如配置文件、文档说明等。

项目的启动文件介绍

此项目作为一个npm包，没有传统意义上的“启动文件”直接运行整个项目。它通过npm的命令进行管理，主要通过开发者在本地开发环境编译或测试时使用。对于最终用户而言，关键的交互是通过将其作为Prettier的插件来集成到自己的构建或者编辑器中，而不是直接启动这个项目本身。

项目的配置文件介绍

Prettier全局配置

在你的项目中使用 prettier-plugin-sql-cst，你需要有一个Prettier的配置文件，通常是.prettierrc(JSON格式), .prettierrc.js, 或者.prettierrc.yaml。为了启用此插件，你可能需要添加以下配置至你的.prettierrc文件中：

{
  "plugins": ["prettier-plugin-sql-cst"]
}

插件特定配置

除了基本的Prettier配置外，prettier-plugin-sql-cst 提供了一些特定于SQL格式化的选项，可以在.prettierrc或其他Prettier配置文件中设置，例如：

{
  "sqlKeywordCase": "upper",
  "sqlParamTypes": [],
  "sqlCanonicalSyntax": true
}

• sqlKeywordCase: 控制SQL关键字的大小写，默认为大写(upper)，也可以设为小写(lower)或保留原有(preserve)。
• sqlParamTypes: 绑定参数类型的数组，比如用来指定SQL查询中的占位符 $1, :name 等的风格。
• sqlCanonicalSyntax: 开启后会对SQL语法进行一些标准化修改，例如强制使用AS关键词等。

请注意，这些配置项允许你定制SQL的格式化规则，以适应不同的个人或团队偏好。

---

综上所述，使用prettier-plugin-sql-cst涉及到理解并配置这些选项，将之整合进你的代码编辑或构建流程之中，以便自动格式化SQL代码，保持一致性和可读性。