Prettier 支持哪些插件?如何开发自定义 Prettier 插件? - 面试题

Prettier 的插件系统和扩展机制

Prettier 本身提供了丰富的语言支持,同时也支持通过插件系统扩展其功能,满足特定项目或语言的格式化需求。

插件类型

1. 语言解析器插件 为 Prettier 添加对新语言的支持,例如:

@prettier/plugin-php - PHP 语言支持
@prettier/plugin-pug - Pug 模板语言支持
@prettier/plugin-ruby - Ruby 语言支持
@prettier/plugin-swift - Swift 语言支持

2. 格式化增强插件 扩展现有语言的格式化能力,例如:

prettier-plugin-organize-imports - 自动组织 import 语句
prettier-plugin-sort-json - 对 JSON 键进行排序
prettier-plugin-packagejson - 格式化 package.json 文件

插件安装和使用

1. 安装插件

bash
# 安装 PHP 插件
npm install --save-dev @prettier/plugin-php

# 安装 import 组织插件
npm install --save-dev prettier-plugin-organize-imports

2. 配置插件 在 .prettierrc 中配置:

json
{
  "plugins": [
    "@prettier/plugin-php",
    "prettier-plugin-organize-imports"
  ]
}

3. 使用插件格式化

bash
# 格式化 PHP 文件
prettier --write index.php

# 格式化 JavaScript 文件(会自动组织 import)
prettier --write index.js

自定义插件开发

1. 插件结构

javascript
// my-prettier-plugin/index.js
module.exports = {
  languages: [
    {
      name: "MyLanguage",
      parsers: ["my-parser"],
      extensions: [".mylang"],
    },
  ],
  parsers: {
    "my-parser": {
      parse: (text, parsers, options) => {
        // 解析代码为 AST
      },
      astFormat: "my-ast",
    },
  },
  printers: {
    "my-ast": {
      print: (path, options, print) => {
        // 将 AST 转换为格式化后的代码
      },
    },
  },
};

2. 插件配置

json
{
  "plugins": ["./my-prettier-plugin"]
}

常用插件推荐

1. 代码组织类

prettier-plugin-organize-imports - 自动组织和排序 import
prettier-plugin-sort-imports - 排序 import 语句

2. 特定语言类

@prettier/plugin-php - PHP 格式化
@prettier/plugin-pug - Pug 模板格式化
@prettier/plugin-ruby - Ruby 格式化

3. 文件增强类

prettier-plugin-packagejson - 优化 package.json 格式
prettier-plugin-sort-json - 排序 JSON 键

4. 框架特定类

prettier-plugin-tailwindcss - Tailwind CSS 类名排序
prettier-plugin-astro - Astro 框架支持

插件最佳实践

1. 选择合适的插件

评估插件的维护状态和社区活跃度
测试插件对项目代码的影响
考虑插件与现有工具的兼容性

2. 版本管理

锁定插件版本避免意外变更
定期更新插件以获取最新功能和修复
记录插件版本变更

3. 性能考虑

避免安装过多插件影响性能
使用缓存机制提高格式化速度
在 CI 中测试插件性能影响

4. 团队协作

在文档中说明使用的插件
确保团队成员安装相同的插件
在 CI 中验证插件配置

通过合理使用 Prettier 插件,可以扩展其功能,满足各种项目的格式化需求。