Sublime构建系统本身不负责格式化,需依赖外部工具并精确配置命令。它仅执行命令并捕获输出,不解析语法或重排结构;必须指定格式化工具(如black、prettier)、确保其已安装且路径可达,并通过参数(如"-"读stdin、--stdin-filename、--parser)控制输入源、文件类型与编码,配合selector限定语言范围,才能实现可靠格式化。

Sublime构建系统本身不负责格式化,得靠外部工具+命令拼装
构建系统(Build System)在 Sublime 里本质是“执行一条命令并捕获输出”,它不会解析语法、也不会重排代码结构。想用它做格式化,必须明确两点:你调用的是哪个格式化工具(prettier、black、sqlformat),以及这个工具是否已安装且能被 Sublime 正确调用。
常见误区是以为配个 { "cmd": ["prettier"] } 就能自动格式化当前文件——实际它只会把文件内容原样传给 prettier,但默认不写回、不覆盖、不处理选区。必须显式加参数控制行为。
- Linux/macOS 下确保
prettier在$PATH中,终端能直接运行prettier --version - Windows 需确认
prettier.cmd或全局 npm bin 路径已加入系统环境变量(Sublime 不继承 shell 的 PATH,除非你改过启动方式) - 构建系统无法感知光标位置或选区范围,所以它适合全文件格式化,不适合只格式化一段 JS 片段
配置 Python 文件用 black 格式化的 Build System
以 black 为例,它支持 --stdin-filename 和 --line-length 等参数,但关键是要让 Sublime 把当前文件内容喂进去,并把结果替换回来。不能只写 ["black", "$file"],那会生成新文件或报错。
推荐配置(保存为 BlackFormatter.sublime-build):
{
"cmd": ["black", "-", "--stdin-filename", "$file", "--line-length=88"],
"selector": "source.python",
"working_dir": "$file_path",
"env": {"PYTHONIOENCODING": "utf-8"},
"target": "exec",
"encoding": "utf-8"
}
-
"-"表示从 stdin 读取,配合 Sublime 的exectarget 才能把当前视图内容传入 -
"--stdin-filename"是必须的,否则black无法推断类型提示风格(如是否启用py310+规则) -
"env"项防止中文路径或字符串导致UnicodeEncodeError - 别漏掉
"selector": "source.python",否则右键菜单里不会出现该构建系统
JS/TS 文件用 prettier 构建系统要注意输入流和语法识别
和 Python 类似,prettier 默认不读 stdin,必须加 --stdin-filepath 并确保传入的内容是合法 JS/TS。如果当前文件 syntax 是 Plain Text,Sublime 不会触发构建系统(即使手动选了也不行)。
- 右下角必须显示
JavaScript、TypeScript或Vue Component,不能是Plain text - 构建命令中必须含
--stdin-filepath "$file",否则prettier无法判断是否启用 JSX/TSX 规则 - 若用
prettier --write,它会直接改磁盘文件,但 Sublime 不会自动重载——容易造成编辑器内容与磁盘不一致 - 更稳妥的做法是走 stdin 流式处理:
["prettier", "--stdin-filepath", "$file", "--parser", "typescript"](根据 syntax 动态指定 parser)
SQL、JSON、YAML 等语言需额外注意工具链兼容性
像 sqlformat(python-sqlparse)、jq、yq 这类工具对输入格式极其敏感。一个 JSON 字符串里多一个逗号,jq 就静默失败,构建系统也只显示“Finished”,不报错。
- SQLBeautify 插件比构建系统更可靠,因为它做了语法预检和错误包裹;纯构建系统建议只用于已知干净的 SQL 片段
- 用
jq格式化 JSON 时,务必加--compact-output或--indent 2,否则默认不换行 - YAML 没有官方 CLI 工具,
yqv4 之后命令变复杂,["yq", "eval", ".", "-P"]才等价于“美化输出” - 所有构建系统都绕不开编码问题:UTF-8 BOM、Windows CRLF、混合空格缩进都会让某些工具直接退出
真正难的不是写那几行 JSON 配置,而是让工具链每一步都吐出可预测的输出——格式化失败往往不报错,只返回原始文本,你得靠肉眼对比才能发现没生效。

















