sqlfluff 3.3.1

由Datacoves提供支持，体验集成VSCode、dbt-core、SqlFluff和Airflow的强大功能，访问Datacoves.com获取更多信息。

vscode-sqlfluff简介

vscode-sqlfluff是一个为SQLFluff设计的VSCode扩展，旨在提供SQL和dbt的linting和自动格式化功能。通过这个扩展，您可以轻松地检查和修复SQL代码中的问题。

使用"Format Document"功能可以自动修复linting违规问题，但请注意，并非所有违规问题都可以自动修复，"Format Selection"功能目前不支持。

配置指南

要使用此扩展，您需要先安装并将SQLFluff添加到系统路径中。如果SQLFluff已安装但无法找到，请在您的设置中添加路径。可以通过在终端中输入which sqlfluff来查找路径。

您可以通过手动编辑VSCode的settings.json文件或通过用户界面来配置设置。如果选择手动编辑settings.json文件，请打开VSCode命令面板并输入settings.json，选择"Preferences: Open Settings"，然后在settings.json中添加以下配置选项：

  "sqlfluff.config": "${workspaceFolder}/.sqlfluff",
  "sqlfluff.dialect": "mysql",
  "sqlfluff.env.environmentVariables": [
    {
      "key": "example_key",
      "value": "example_value"
    }
  ],
  "sqlfluff.env.customDotEnvFiles": [
    "${workspaceFolder}/example.env"
  ],
  "sqlfluff.env.useDotEnvFile": true,
  "sqlfluff.excludeRules": ["L009"],
  "sqlfluff.executablePath": "sqlfluff",
  "sqlfluff.ignoreLocalConfig": false,
  "sqlfluff.ignoreParsing": false,
  "sqlfluff.rules": [],
  "sqlfluff.suppressNotifications": false,
  "sqlfluff.workingDirectory": "",
  /* Linter */
  "sqlfluff.linter.arguments": [],
  "sqlfluff.linter.run": "onType",
  "sqlfluff.linter.diagnosticSeverity": "error",
  "sqlfluff.linter.diagnosticSeverityByRule": [
    {
      "rule": "L010",
      "severity": "warning"
    }
  ],
  "sqlfluff.linter.lintEntireProject": true,
  /* Formatter */
  "sqlfluff.format.arguments": ["--FIX-EVEN-UNPARSABLE"],
  "sqlfluff.format.enabled": true,

dbt配置

对于dbt项目，您需要以下设置来进行linting和格式化文档：

  "sqlfluff.linter.run": "onSave",
  "sqlfluff.experimental.format.executeInTerminal": true,
  "editor.formatOnSave": false,

格式化文件

默认情况下，您可以通过格式化功能使用SQLFluff修复文件，相当于调用sqlfluff fix <path>。

显示文档

当您悬停在问题上时，会弹出一个窗口，解释问题并提供文档链接。对于SQLFluff 2.0.0及以上版本，此链接将直接跳转到相关规则的文档页面；对于2.0.0之前的版本，链接将跳转到文档首页。

VSCode变量

在配置中，executablePath和config设置可以使用一些VSCode变量，格式为${variableName}。以下是一些有用的变量：

• fileWorkspaceFolder：包含当前打开文件的工作区文件夹路径
• workspaceFolder：在VSCode中打开的第一个工作区文件夹路径
• workspaceFolderBasename：在VSCode中打开的文件夹路径的最后一部分
• fileDirname：当前打开文件的目录名

以下是一些不太常用的变量：

• file：当前打开的文件
• relativeFile：相对于workspaceFolder的当前打开文件
• fileBasename：文件路径的最后一部分
• fileBasenameNoExtension：文件路径的最后一部分，不含扩展名
• fileExtname：当前打开文件的扩展名
• lineNumber：活动文件中当前选中的行号
• selectedText：活动文件中当前选中的文本
• execPath：运行VSCode可执行文件的路径

遇到问题？

打开命令面板并运行"SQLFluff Debug Extension"命令，检查输出通道以查看此扩展运行的SQLFluff命令。

如果这无法解决您的问题，请在https://github.com/sqlfluff/vscode-sqlfluff/issues上提交问题。

Open-VSX

访问open-vsx.org/extension/sqlfluff/vscode-sqlfluff获取更多信息。

致谢/链接

• dorzey
• VSCode的扩展样本
• VSCode的测试文档

许可证

此项目遵循MIT许可证（MIT）。有关更多信息，请查看许可证文件。