能否将ESLint插件集成至已有npm包供其他项目扩展使用？

当然可以，完全不需要单独发布ESLint插件，你可以把它嵌入到已有的npm包中，让其他项目直接复用，只维护一个包即可。下面是具体的实现步骤：

1. 在现有包中组织ESLint插件代码 #

在你的现有npm包内创建专门的目录存放ESLint插件代码，比如eslint-plugin，目录结构示例如下：

your-existing-package/
├── eslint-plugin/
│   ├── index.js       # ESLint插件入口文件
│   └── rules/         # 自定义规则目录
│       ├── no-console-log.js
│       └── custom-indent.js
├── src/               # 原有包的业务代码
├── package.json
└── ...

插件入口文件index.js的基础写法示例：

module.exports = {
  rules: {
    'no-console-log': require('./rules/no-console-log'),
    'custom-indent': require('./rules/custom-indent')
  }
};

2. 配置package.json，确保插件代码被发布并可访问 #

在现有包的package.json中添加两个关键配置：

• exports字段：明确暴露插件的入口路径，让其他项目能精准导入
• files字段：确保插件目录被包含在发布的npm包中

示例配置：

{
  "name": "your-existing-package",
  "version": "1.2.3",
  "exports": {
    "./eslint-plugin": "./eslint-plugin/index.js"
  },
  "files": [
    "eslint-plugin/",
    "src/",
    // 原有需要发布的文件列表
  ],
  // 可选：添加ESLint作为peer依赖，避免重复安装
  "peerDependencies": {
    "eslint": "^8.0.0"
  }
}

3. 在其他项目中使用嵌入的插件 #

目标项目只需先安装你的现有npm包，然后在ESLint配置文件（比如.eslintrc.js）中直接引入并使用插件：

module.exports = {
  env: {
    browser: true,
    es2021: true
  },
  plugins: [
    // 通过包名+路径引入插件
    'your-existing-package/eslint-plugin'
  ],
  rules: {
    // 使用插件的自定义规则，格式为「插件名/规则名」
    'your-existing-package/eslint-plugin/no-console-log': 'error',
    'your-existing-package/eslint-plugin/custom-indent': ['warn', 2]
  }
};

4. 后续维护注意事项 #

• 插件的更新直接跟随现有包的版本迭代，无需单独发布版本，减少维护成本
• 如果插件需要新增依赖，直接添加到现有包的dependencies或peerDependencies中即可
• 确保目标项目安装的现有包版本包含你更新后的插件代码

内容的提问来源于stack exchange，提问作者Steve Clever