VS Code Extensions
TSQL Formatter (SQL Server)

TSQL Formatter (SQL Server)

by wujingtao

SQL Formatter is a VS Code and Cursor extension for formatting Microsoft SQL Server T-SQL, supporting full-document and selection formatting through the editor, command palette, and keyboard shortcuts.

Downloads

156

Rating

— (0)

Version

0.0.2

Last updated

Apr 08, 2026

在 Visual Studio Code / Cursor 中格式化 SQL 的扩展。底层使用 sql-formatter 对选区或整篇文档排版。

适用范围(重要)

当前第一版仅针对 Microsoft SQL Server,即 T-SQL(Transact-SQL)语法。

  • 方言固定为 transactsql,按 T-SQL 习惯做关键字、换行与缩进。
  • 若你写的是 MySQL、PostgreSQL、SQLite 等其他方言,格式化结果可能不符合该引擎的习惯,后续版本会逐步开放方言与选项。

功能

  • 格式化选区或全文:无选区时格式化整个文件;有选区时只格式化选中内容。
  • 与编辑器集成:支持「格式化文档」「格式化选中内容」等内置格式化入口(语言需为 SQL)。
  • 命令:命令面板中执行 「SQL Formatter: Format SQL」(sql-formatter.format)。

使用方式

  1. 将文件语言模式设为 SQL(或对应关联为 sql 的文件)。
  2. 任选其一:
    • 快捷键:Ctrl+K Ctrl+D(Windows / Linux)或 Cmd+K Cmd+D(macOS);
    • 命令面板:Format SQL;
    • 右键 / 命令:「格式化文档」或「格式化选中内容」。

空文档或仅空白时不会改写内容。

要求

  • VS Code 引擎版本:见 package.json 中的 engines.vscode。
  • 本地开发需安装 Node.js,并使用 pnpm 安装依赖、编译后再调试扩展。

设置

package.json 中已声明部分配置项(如方言、关键字大小写),当前第一版尚未全部接入到运行时;行为以扩展内固定的 T-SQL 规则为准。后续版本将把设置与界面说明对齐。

已知限制

  • 仅保证 SQL Server(T-SQL) 场景下的体验;其他方言请谨慎使用或等待后续更新。

更新日志

0.0.1

  • 首版:仅支持 SQL Server(T-SQL)格式化。