NX 15本地生成器添加--version参数触发Schema校验错误

问题根源分析 #

你遇到的错误来自两个核心问题：

1. NX CLI全局参数冲突：NX自带--version全局参数用于查看版本，你传递的--version=ggggg会被CLI优先解析为全局参数，而非生成器的自定义参数，导致生成器接收到的version值为false（全局参数--version无值时的默认解析结果），与schema定义的string类型不匹配。
2. schema配置疏漏：若schema中version字段未明确设置type: "string"，也会触发类型验证失败。

修复步骤 #

1. 修正schema.json配置 #

确保version字段类型明确为字符串，示例配置如下：

{
  "$schema": "http://json-schema.org/schema",
  "id": "@design-system/components-library:new-component",
  "title": "New Component Generator",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "组件名称",
      "required": true
    },
    "version": {
      "type": "string",
      "description": "组件版本号",
      "required": false
    }
  },
  "required": ["name"]
}

2. 解决参数名冲突问题 #

有两种可选方案：

方案一：修改生成器参数名（推荐）

避免与NX全局参数重名，将schema中的version改为componentVersion，同时更新生成器代码的参数引用：

• 更新schema.json的properties字段：

  "componentVersion": {
    "type": "string",
    "description": "组件版本号",
    "required": false
  }
  

• 生成器代码（generator.ts）中调整参数接收：

  import { Tree } from '@nrwl/devkit';
  import { Schema } from './schema';
  
  export default async function (tree: Tree, schema: Schema) {
    // 使用schema.componentVersion替代schema.version
    console.log('组件名称:', schema.name);
    console.log('组件版本:', schema.componentVersion);
    // 你的生成器逻辑
  }
  

• 执行命令改为：

  npx nx generate @design-system/components-library:new-component --name=fffff --componentVersion=ggggg --no-interactive --dry-run
  

方案二：使用--分隔全局参数与生成器参数

若不想修改参数名，可在命令中用--标记生成器参数的起始位置，让CLI将后续参数传递给生成器：

npx nx generate @design-system/components-library:new-component --name=fffff -- --version=ggggg --no-interactive --dry-run

3. 验证修复结果 #

执行修改后的命令，若schema验证通过，生成器逻辑会正常执行，不再出现Property 'version' does not match the schema的错误。

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