✨ 构建自己的 Prettier 配置

最终效果: https://github.com/pinky-pig/prettier-config.git

安装:

pnpm add -D prettier @arvinn/prettier-config

配置:

{
    "prettier": "./index.js"
}

📦 安装

🛠️ 初始化项目

初始化项目就是 npm init,然后一路回车。

1️⃣ 安装 Prettier

pnpm add -D prettier

2️⃣ 创建配置文件

touch index.js

3️⃣ 写入基本配置

module.exports = {
  // 是否在语句末尾添加分号
  semi: false,
  // 使用单引号替代双引号
  singleQuote: true,
  // 在多行逗号分隔的结构中尾部加逗号,比如数组或对象最后一个元素后面也加逗号
  trailingComma: 'all',
}

4️⃣ 在 package.json 中添加 Prettier 配置

虽然很多项目使用 .prettierrc.cjs、.prettierrc 等文件,但我们这里用 index.js,那么就不需要再创建一个文件,然后软连接 index 文件了,所以只需在 package.json 中指定路径:

{
  "prettier": "./index.js"
}

📚 参考文档:Prettier Configuration

5️⃣ 测试 CLI 格式化效果

创建 test.js 文件,写入如下代码:

const a= 1;
const b= 2;

执行命令格式化:

npx prettier --write test.js

执行成功后,test.js 应该格式化为无分号、空格对齐的代码,说明配置生效 ✅

🧩 VSCode 中启用 Prettier

CLI 有效果还不够,编辑器中保存时自动格式化才舒服点 😎

1️⃣ 安装插件 & 检查启用状态 在 VSCode 插件市场搜索并安装 Prettier - Code formatter。

📌 安装后建议重启 VSCode(也可以不重启,看好输出内容就行)。可在菜单「输出」->「Prettier」中查看日志确认是否启用。

Image

💡 插件未启用时日志如下:

["INFO" - 16:30:23] Extension Name: esbenp.prettier-vscode.
["INFO" - 16:30:23] Extension Version: 11.0.0.
["INFO" - 16:30:23] Extension is disabled. No formatters will be registered. To enable, change the `prettier.enable` to `true` and restart VS Code.

2️⃣ 配置 .vscode/settings.json

创建 .vscode/settings.json 文件,并添加:

{
  "prettier.enable": true,
  "editor.formatOnSave": true
}

3️⃣ 测试保存时自动格式化

重新打开刚才的 test.js,随意打乱格式后保存,观察是否自动格式化 🔄

🚀 发布配置工具包 我使用 bumpp 来自动管理版本号并发布到 npm:

{
  "scripts": {
    "release": "bumpp && pnpm publish"
  }
}

这样一行命令就能更新版本、打 tag、发布,非常方便 🎉

✅ 总结 现在拥有了一个可复用、可发布、在 CLI 与编辑器中都生效的 Prettier 配置工具包 🎯 无论是个人项目还是团队共享,都能提升开发效率,保持代码风格一致!

🧼 格式整洁,💨 发布流畅,👨‍💻 编辑器自动完成!