JHipster自定义蓝图：如何定义自定义命令行参数（选项）

要在JHipster蓝图中添加可通过命令行传递的自定义参数，不能直接在单个Generator的constructor里定义选项——因为JHipster主CLI会优先解析所有命令行参数，未注册为**共享选项（sharedOptions）**的参数会被判定为未知选项。正确步骤如下：

1. 定义共享选项 #

在蓝图项目中创建（或修改）generators/shared-options.js文件，集中管理自定义参数：

module.exports = {
  parentProject: {
    desc: '指定父项目名称',
    type: String,
    alias: 'pp', // 可选：添加短别名方便快速使用
    default: undefined // 可选：设置参数默认值
  }
};

2. 在蓝图主Generator中导出共享选项 #

找到蓝图的主Generator文件（通常是generators/app/index.js），导入并通过静态方法导出共享选项，让JHipster CLI识别这些参数：

const GeneratorBase = require('generator-jhipster/generators/generator-base');
const sharedOptions = require('../shared-options');

module.exports = class extends GeneratorBase {
  constructor(args, opts, features) {
    super(args, opts, { taskPrefix: 'my-java-blueprint:', ...features });
  }

  // 注册共享选项，供JHipster CLI解析
  static get sharedOptions() {
    return sharedOptions;
  }

  // 其他生成逻辑...
};

如果你的参数需要在实体Generator中使用（比如处理JDL文件场景），要在实体Generator类中添加同样的static get sharedOptions()方法，或者让实体Generator继承包含共享选项的基类。

3. 在Generator中读取参数 #

在需要使用该参数的Generator生命周期方法中，直接从this.options获取：

async prompting() {
  // 保留交互式提问逻辑，当命令行未传入参数时触发
  const prompts = [
    {
      type: 'input',
      name: 'parentProject',
      message: '请输入父项目名称',
      when: () => !this.options.parentProject
    }
  ];

  const answers = await this.prompt(prompts);
  // 合并命令行参数与交互式回答结果
  this.parentProject = this.options.parentProject || answers.parentProject;
}

4. 验证命令行使用 #

现在可以正常通过命令行传递参数：

jhipster jdl --blueprints my-java-blueprint --parentProject MyParentProject --skip-install ~/myjdl.jdl

关键原因说明 #

JHipster的CLI架构要求所有命令行参数必须先通过sharedOptions注册，主CLI才能识别并将参数传递给对应的蓝图Generator。直接在单个Generator的constructor中调用this.option()或this.jhipsterOptions()，无法让主CLI感知到该参数的存在，因此会抛出unknown option错误。

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