如何读取npm包安装时传入的参数，实现可选插件依赖安装

需求明确 #

维护的npm包my-package需要支持：用户安装时通过参数指定官方插件，自动安装对应插件；插件不包含在主包依赖中，主包代码自行检查插件是否已安装。

已排除方案说明 #

之前调研的几个方案不符合需求：

• optionalDependencies：会默认安装所有可选依赖，无法实现按需选择安装。
• preinstall脚本：pnpm中该脚本仅在包自身安装内部依赖时触发，用户安装my-package时不会执行，且执行时机晚于依赖安装。
• pnpm hooks.readPackage：同样仅作用于包内部依赖安装流程，无法响应用户安装主包的操作。

可行方案推荐 #

方案1：环境变量传参 + postinstall脚本 #

这是最贴近需求的「安装时触发」方案：

1. 约定用户通过环境变量传递插件列表，执行命令示例：

   PLUGINS=my-plugin pnpm install my-package
   

   多个插件用逗号分隔：PLUGINS=plugin1,plugin2 pnpm install my-package
2. 在my-package的package.json中添加postinstall脚本：

   {
     "scripts": {
       "postinstall": "node ./scripts/install-plugins.js"
     }
   }
   

3. 编写install-plugins.js处理逻辑：

   const { execSync } = require('child_process');
   const plugins = process.env.PLUGINS?.split(',') || [];
   
   // 仅在用户顶层安装时执行，避免主包自身安装依赖时触发
   if (process.env.npm_config_top === 'true') {
     plugins.forEach(plugin => {
       const pluginName = `my-package-plugin-${plugin}`; // 统一插件命名前缀
       try {
         console.log(`安装插件：${pluginName}`);
         execSync(`pnpm install ${pluginName}`, { stdio: 'inherit' });
       } catch (err) {
         console.warn(`插件${pluginName}安装失败：${err.message}`);
       }
     });
   }
   

方案2：自定义CLI初始化命令 #

如果接受用户安装后再执行一步命令，这个方案扩展性更强：

1. 给my-package添加CLI功能，在package.json中声明入口：

   {
     "bin": {
       "my-package": "./cli.js"
     }
   }
   

2. 在cli.js中实现setup命令处理插件安装：

   const { program } = require('commander');
   const { execSync } = require('child_process');
   
   program
     .command('setup')
     .option('--plugin <name>', '指定要安装的插件，可多次使用')
     .action((options) => {
       const plugins = Array.isArray(options.plugin) ? options.plugin : [options.plugin].filter(Boolean);
       plugins.forEach(plugin => {
         const pluginName = `my-package-plugin-${plugin}`;
         try {
           console.log(`安装插件：${pluginName}`);
           execSync(`pnpm install ${pluginName}`, { stdio: 'inherit' });
         } catch (err) {
           console.warn(`插件${pluginName}安装失败：${err.message}`);
         }
       });
     });
   
   program.parse();
   

3. 用户使用流程：

   pnpm install my-package
   npx my-package setup --plugin my-plugin
   

   支持多插件：npx my-package setup --plugin plugin1 --plugin plugin2

方案3：peerDependenciesMeta 引导式安装 #

完全依赖npm/pnpm规范，无需自定义脚本：

1. 在my-package的package.json中声明插件为可选peer依赖：

   {
     "peerDependencies": {
       "my-package-plugin-my-plugin": "^1.0.0"
     },
     "peerDependenciesMeta": {
       "my-package-plugin-my-plugin": {
         "optional": true
       }
     }
   }
   

2. 在主包的README或入口文件中提示用户：

   需要使用my-plugin功能？请执行：pnpm install my-package my-package-plugin-my-plugin

方案选择建议 #

• 追求安装时传参体验：选方案1，通过环境变量传递插件列表，postinstall脚本自动安装。
• 需要更灵活的插件管理（比如初始化配置、批量操作）：选方案2，CLI命令扩展性更强。
• 优先遵循npm规范，不想维护自定义脚本：选方案3，引导用户手动安装插件。

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