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

目录

• 概览
• 更新图案
• 更新 SQLFluff 版本
• 发展
• 维护者的注释

概览

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

更新图案

# 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/(中文(简体) )

发展

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

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

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过滤为安全网).