sublime如何设置代码自动格式化? (Prettier配置方法)

17次阅读

sublime Text 需通过 jsPrettier 插件、node.js 环境及正确配置实现 Prettier 自动格式化;核心步骤包括安装 node.js 和 prettier CLI、安装 JsPrettier 插件、启用 auto_format_on_save 并配置 prettier_cli_path 路径及文件扩展名。

sublime如何设置代码自动格式化? (Prettier配置方法)

sublime text 本身不自带 Prettier 格式化功能,需通过插件 + Node.js 环境 + 配置联动实现自动格式化。核心是安装 Prettier 插件,并让它调用本地或全局安装的 prettier CLI 工具

安装前提:确保 Node.js 和 Prettier CLI 可用

打开终端(命令行),运行以下命令确认环境就绪:

  • node -v —— 应输出版本号(如 v18.17.0)
  • npm -v —— 应输出 npm 版本
  • prettier –version —— 若提示 command not found,需全局安装:
    npm install -g prettier

安装 Sublime 插件:JsPrettier

推荐使用成熟稳定的 JsPrettier(非 “Prettier” 同名插件,后者已停止维护):

  • 在 Sublime 中按 Ctrl+Shift+P(Win/linux)或 Cmd+Shift+P(Mac)打开命令面板
  • 输入 Package Control: Install Package 回车
  • 搜索并安装 JsPrettier

配置 JsPrettier 实现保存时自动格式化

安装后默认不自动格式化,需手动配置触发时机和规则:

  • 菜单栏 → Preferences → Package Settings → JsPrettier → Settings
  • 在右侧用户设置中添加以下内容(覆盖默认行为):
{   "auto_format_on_save": true,   "auto_format_on_save_excludes": [     "*/node_modules/*",     "*/dist/*",     "*/build/*"   ],   "custom_file_extensions": [     "js", "jsx", "ts", "tsx", "vue", "svelte", "json", "graphql", "mdx"   ],   "prettier_cli_path": "/usr/local/bin/prettier"  // macos/Linux 路径示例   // windows 示例:"prettier_cli_path": "C:\Users\YourName\appData\Roaming\npm\prettier.cmd" }

⚠️ 注意:prettier_cli_path 必须填对。不确定路径?终端执行 which prettier(macOS/Linux)或 where prettier(Windows)获取真实路径。

可选:配合 .prettierrc 配置个性化规则

在项目根目录新建 .prettierrc 文件(JSON 或 YAML 格式),JsPrettier 会自动读取:

{   "semi": false,   "singleQuote": true,   "tabWidth": 2,   "trailingComma": "es5" }

这样不同项目可用不同风格,无需改 Sublime 设置。

基本上就这些。保存文件时自动格式化即生效,快捷键 Ctrl+Alt+F(Win/Linux)或 Cmd+Alt+F(Mac)也可手动触发。不复杂但容易忽略 CLI 路径和 auto_format_on_save 开关。

text=ZqhQzanResources