# @codacy/tools-sqlfluff-4 中文文档

规范地址：https://npmcn.com/package/%40codacy/tools-sqlfluff-4/

版本：0\.28\.0
npm 元数据更新时间：2026-11-09T13:47:22.160Z
中文译文更新时间：2026-11-10T05:48:12.542Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40codacy/tools-sqlfluff-4
原文对照：https://npmcn.com/package/%40codacy/tools-sqlfluff-4/?lang=original
项目主页：https://github.com/codacy/analysis-cli
源码仓库：https://github.com/codacy/analysis-cli

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：44.1 kB，7 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=20\.0\.0
- 运行依赖：1 个
- 首次发布：2026-09-02T12:26:47.762Z
- 最新版本发布：2026-11-09T13:47:21.960Z
- 近 30 天下载量：11691（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：9（近 12 个月 9 个）

## 中文简介

SQLFluff 适配器 — CLI- mode SQL linter

## 安装

```sh
npm install @codacy/tools-sqlfluff-4
```

也可以使用：`pnpm add @codacy/tools-sqlfluff-4`、`yarn add @codacy/tools-sqlfluff-4`、`bun add @codacy/tools-sqlfluff-4`

## README

# @codacy/tools-sqlfluff-4 (英语)

## 目录

-   [概览](https://npmcn.com/package/%40codacy/tools-sqlfluff-4/#readme-overview)
-   [更新图案](https://npmcn.com/package/%40codacy/tools-sqlfluff-4/#readme-updating-patterns)
-   [更新 SQLFluff 版本](https://npmcn.com/package/%40codacy/tools-sqlfluff-4/#readme-updating-the-sqlfluff-version)
-   [发展](https://npmcn.com/package/%40codacy/tools-sqlfluff-4/#readme-development)
-   [维护者的注释](https://npmcn.com/package/%40codacy/tools-sqlfluff-4/#readme-notes-for-maintainers)

* * *

## 概览

多透视 SQL 插件 [SQLFluff 高压](https://sqlfluff.com/)使用CLI执行战略 -- -- 产卵 `sqlfluff lint --format json` 从管理中的 Python venv 从 `spawnTool()` 并分析它的 JSON 输出.

| 财产 | 数值 |
| --- | --- |
| 工具标识 | `SQLFluff` |
| 编码 UUID | `eebd5ab6-3bef-4192-843c-f52bc4dce861` |
| 战略 | 国 际 |
| 语文 | SQL 组合键 |
| 二进制 | `sqlfluff` (中文(简体) ) |
| 文件图案 | `**/*.sql` |

## 更新图案

```bash
# Re-fetch pattern metadata from the Codacy API
pnpm prefetch

# Commit the result
git add src/patterns.json
```

这个 `prefetch` 脚本调用 `packages/tools/scripts/fetch-patterns.mjs` 与工具UUID从Codacy API下载模式元数据.

模式 ID 遵循格式 `SQLFluff_AL01_aliasing.table`, (中文(简体) ), `SQLFluff_LT01_layout.spacing`等——它们包括了短码和规则名.

## 更新 SQLFluff 版本

1.  更新 `preferredVersion` 内 `src/adapter.ts`
2.  更新 `PIP_PACKAGES` 带有新被绑定版本的阵列
3.  运行 `pnpm prefetch` 以检查新的/撤消的规则
4.  运行 `pnpm test` 以验证兼容性
5.  如果主要版本更改,请创建新的适配软件包(`sqlfluff-4/`(中文(简体) )

## 发展

```bash
pnpm build    # Build with tsup
pnpm test     # Run tests (requires sqlfluff in PATH or venv)
```

要在当地安装 sqlfluff 进行测试:

```bash
pip install sqlfluff==4.3.0
```

## 维护者的注释

-   **多声道支持**: SQLFluff支持ANSI,PostgreSQL,MySQL,BigQuery,Snowflake等多种SQL方言. 生成的配置默认值为 `dialect = ansi`。用户可以通过本地 `.sqlfluff` 配置文件 .
-   **Python pip 依赖性**: SQLFluff要求Python 3作为运行时间. 适配器使用孤立的阴道 `~/.codacy/runtimes/SQLFluff/venv/` (按键: 稳定工具ID,而不是软件包文件夹名称,所以一个大的凸起会保留 venv 并且可以 提升它的位置,而不是让它成为孤儿.
-   **模式标识映射**: SQLFluff 的 JSON 输出报告 `code` (例如:. `AL01`),但Codacy图案ID同时包括代码和名称(例如. `SQLFluff_AL01_aliasing.table`) (中文(简体) ). 适配器构建 `CODE_TO_PATTERN` 反向查找地图从 `patterns.json` 在模块初始化时.
-   **配置生成**: 当模式被启用但不存在本地配置时,适配器生成一个 `.sqlfluff` INI 文件在 `.codacy/generated/` 与 `dialect = ansi`, (中文(简体) ), `templater = raw`,则a `rules` 列表来自启用的模式代码.
-   出站代码0=无违反,1=发现违反(正常),2=出错.
-   `start_line_no` 财务报告和审定财务报表 `start_line_pos` 在 sqlfluff 的 JSON 输出是 1 基,匹配 Codacy 的会.
-   配置文件检测只检查 `.sqlfluff` 在寄存器根中.
-   模式过滤既为配置级别(生成的配置只允许所请求的规则)也为后hoc(结果被启用的模式ID过滤为安全网).

## 常见问题

### @codacy/tools-sqlfluff-4 是什么？

SQLFluff 适配器 — CLI- mode SQL linter

### 如何安装 @codacy/tools-sqlfluff-4？

在项目目录运行 npm install @codacy/tools-sqlfluff-4，或使用 pnpm add / yarn add / bun add。

### @codacy/tools-sqlfluff-4 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @codacy/tools-sqlfluff-4 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @codacy/tools-sqlfluff-4 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=20\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @codacy/tools-sqlfluff-4 可以商用吗？

@codacy/tools-sqlfluff-4 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @codacy/tools-sqlfluff-4 的下载量有多少？

根据 npm 官方下载统计，@codacy/tools-sqlfluff-4 在 2026/10/10 – 2026/11/08 这 30 天内被下载 11,691 次，日均约 390 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @codacy/tools-sqlfluff-4 还在维护吗？

最新版本 0\.28\.0 发布于 2026/11/09（今天）；至今共发布 9 个版本，其中过去 12 个月发布了 9 个；首次发布于 2026/09/02。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。