neo-cmp-cli 1.6.8 → 1.7.1

package/README.md

@@ -31,7 +31,7 @@ npm i -g neo-cmp-cli
 #### 2) 创建自定义组件项目
 ```bash
 # 方式一：创建空的自定义组件项目
-neo createProject
+neo create project
 
 # 方式二：根据模板创建自定义组件项目（默认 React+TS，可用 -t 指定模板，-n 指定自定义组件名称）
 neo init
@@ -45,7 +45,7 @@ cd xxCmpProject
 #### 4) 创建自定义组件
 ```bash
 # 在当前项目中创建一个自定义组件
-neo createCmp
+neo create cmp
 ```
 默认在当前项目 src/components/ 目录下新增自定义组件。
 
@@ -63,7 +63,7 @@ neo linkDebug
 需在NeoCRM / 页面设计器端启动 debug 模式，并添加控制台输出的外链脚本地址，方可在页面设计器端使用当前自定义组件。
 
 #### 7) 构建并发布到 NeoCRM
-执行 `neo pushCmp` 即可构建并发布自定义组件至 NeoCRM 平台。  
+执行 `neo push cmp` 即可构建并发布自定义组件至 NeoCRM 平台。  
 **发布前请确保**：`package.json` 的 `name` 唯一、`version` 不重复，并已配置 NeoCRM 平台授权信息。
 
 ##### 需自行添加授权配置
@@ -89,20 +89,20 @@ module.exports = {
 **详细使用说明**：请参考下方「[发布自定义组件至 NeoCRM](#6发布自定义组件至-neocrm)」章节。
 
 #### 8) 删除线上自定义组件
-执行 `neo deleteCmp` 即可从 NeoCRM 平台删除指定的自定义组件。  
+执行 `neo delete cmp` 即可从 NeoCRM 平台删除指定的自定义组件。  
 **删除前请确保**：已配置 NeoCRM 平台授权信息，且确认要删除的组件名称正确（删除操作不可恢复）。  
 **详细使用说明**：请参考下方「[删除线上自定义组件](#8删除线上自定义组件)」章节。
 
 ## 常用命令说明
 - **neo init**: 交互式创建自定义组件（支持 -t、--name）;
-- **neo createProject**: 创建自定义组件项目（支持 --name）;
-- **neo createCmp**: 在当前项目中创建一个自定义组件（支持 --name）;
+- **neo create project**: 创建自定义组件项目（支持 --name）;
+- **neo create cmp**: 在当前项目中创建一个自定义组件（支持 --name）;
 - **neo preview**: 本地预览自定义组件内容（支持 --name），默认支持热更新与接口代理;
 - **neo linkDebug**: 外链调试模式，在平台端页面设计器中调试自定义组件;
 - **neo publish2oss**: 构建并上传到对象存储（支持 --name，可自定义配置对象存储）;
-- **neo pushCmp**: 构建并发布到NeoCRM平台（支持 --name，需自行添加授权配置）；
-- **neo pullCmp**: 拉取线上自定义组件（NeoCRM平台）至当前项目（支持 --name，需自行添加授权配置）；
-- **neo deleteCmp**: 删除线上自定义组件（NeoCRM平台）（支持 --name，需自行添加授权配置）。
+- **neo push cmp**: 构建并发布到NeoCRM平台（支持 --name，需自行添加授权配置）；
+- **neo pull cmp**: 拉取线上自定义组件（NeoCRM平台）至当前项目（支持 --name，需自行添加授权配置）；
+- **neo delete cmp**: 删除线上自定义组件（NeoCRM平台）（支持 --name，需自行添加授权配置）。
 
 ## 开发须知
 #### 1）默认自动识别自定义组件
@@ -156,17 +156,17 @@ neo linkDebug
 将第 1 步生成的「外链脚本地址」添加进来，即可在此页面设计器 / 组件物料面板中看到对应自定义组件。
 
 #### 6）发布自定义组件至 NeoCRM
-执行 `neo pushCmp` 即可构建并发布自定义组件至 NeoCRM 平台，其构建后资源也会上传到 NeoCRM 平台端提供的 CDN 中。  
+执行 `neo push cmp` 即可构建并发布自定义组件至 NeoCRM 平台，其构建后资源也会上传到 NeoCRM 平台端提供的 CDN 中。  
 
 ##### 使用方式
 ```bash
 # 方式一：交互式选择要发布的自定义组件
-neo pushCmp
+neo push cmp
 
 # 方式二：直接指定要发布的自定义组件名称
-neo pushCmp --name=xxCmp
+neo push cmp --name=xxCmp
 # 或
-neo pushCmp -n xxCmp
+neo push cmp -n xxCmp
 ```
 
 ##### 发布前请确保
@@ -233,18 +233,18 @@ A: 请检查 `neo.config.js` 文件中是否配置了 `neoConfig.auth`，确保
 发布成功后，即可在对应租户环境下的页面设计器和表单设计器中使用此自定义组件。
 
 #### 7）拉取线上自定义组件至本地项目
-执行 `neo pullCmp` 即可从 NeoCRM 平台拉取自定义组件源码到当前项目。  
+执行 `neo pull cmp` 即可从 NeoCRM 平台拉取自定义组件源码到当前项目。  
 该命令会将线上自定义组件的源码下载并解析到当前项目的 `src/components` 目录下。
 
 ##### 使用方式
 ```bash
 # 方式一：交互式选择要拉取的自定义组件
-neo pullCmp
+neo pull cmp
 
 # 方式二：直接指定要拉取的自定义组件名称
-neo pullCmp --name=xxCmp
+neo pull cmp --name=xxCmp
 # 或
-neo pullCmp -n xxCmp
+neo pull cmp -n xxCmp
 ```
 
 ##### 拉取前请确保
@@ -258,18 +258,18 @@ neo pullCmp -n xxCmp
 - zip 源文件会保留在 `.neo-cli/zip-source` 目录下，可手动删除
 
 #### 8）删除线上自定义组件
-执行 `neo deleteCmp` 即可从 NeoCRM 平台删除指定的自定义组件。  
+执行 `neo delete cmp` 即可从 NeoCRM 平台删除指定的自定义组件。  
 该命令会删除平台上的自定义组件，删除后该组件将无法在页面设计器和表单设计器中使用。
 
 ##### 使用方式
 ```bash
 # 方式一：交互式选择要删除的自定义组件
-neo deleteCmp
+neo delete cmp
 
 # 方式二：直接指定要删除的自定义组件名称
-neo deleteCmp --name=xxCmp
+neo delete cmp --name=xxCmp
 # 或
-neo deleteCmp -n xxCmp
+neo delete cmp -n xxCmp
 ```
 
 ##### 删除前请确保
@@ -279,11 +279,11 @@ neo deleteCmp -n xxCmp
 ##### 注意事项
 - **删除操作不可恢复**：删除后的自定义组件将无法恢复，请谨慎操作
 - **影响范围**：删除组件后，所有使用该组件的页面和表单将受到影响，请确保没有正在使用的场景
-- **建议先备份**：删除前建议先使用 `neo pullCmp` 拉取组件源码到本地进行备份
+- **建议先备份**：删除前建议先使用 `neo pull cmp` 拉取组件源码到本地进行备份
 
 #### 9）发布自定义组件至CDN
 执行 `neo publish2oss` 即可构建对应自定义组件，并自动将构建后资源上传到对象存储（OSS）中。  
-备注：请优先使用 neo pushCmp。
+备注：请优先使用 neo push cmp。
 
 ##### 发布前请确保
 - **package.json 的 name 唯一**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "neo-cmp-cli",
-  "version": "1.6.8",
+  "version": "1.7.1",
   "description": "前端脚手架：自定义组件开发工具，支持react 和 vue2.0技术栈。",
   "keywords": [
     "neo-cli",

package/src/module/index.js

@@ -161,92 +161,95 @@ yargs
       neoConfigInit('neo.config.js');
     }
   )
-  .command(
-    'createProject [options]',
-    '创建自定义组件项目（含工程代码）',
-    (yargs) => {
-      yargs
-        .reset()
-        .usage(titleTip('Usage') + ': $0 preview [options]')
-        .option('name', {
-          alias: 'n',
-          describe: '自定义组件项目名称'
-        })
-        .alias('h', 'help');
-    },
-    (argv) => {
-      if (argv.name) {
-        mainAction.createCmpProjectByTemplate(argv.name);
-      } else {
-        const questions = [
-          {
-            name: 'name',
-            type: 'input',
-            message: '请设置自定义组件项目名称:'
-          }
-        ];
-
-        inquirer.prompt(questions).then((ans) => {
-          // 验证项目名称是否合法
-          const { isValid, errors } = validateProjectName(ans.name);
-          if (!isValid) {
-            console.error(errors.join('\n'));
-            process.exit(1);
-          }
-
-          if (!ans.name) {
-            console.error('自定义组件项目名称不能为空。');
-            process.exit(1);
-          } else {
-            mainAction.createCmpProjectByTemplate(ans.name);
-          }
-        });
+  .command('create', '创建项目或者组件', (yargs) => {
+    return yargs
+    .command(
+      'project [options]',
+      '创建自定义组件项目（含工程代码）',
+      (yargs) => {
+        yargs
+          .reset()
+          .usage(titleTip('Usage') + ': $0 project [options]')
+          .option('name', {
+            alias: 'n',
+            describe: '自定义组件项目名称'
+          })
+          .alias('h', 'help');
+      },
+      (argv) => {
+        if (argv.name) {
+          mainAction.createCmpProjectByTemplate(argv.name);
+        } else {
+          const questions = [
+            {
+              name: 'name',
+              type: 'input',
+              message: '请设置自定义组件项目名称:'
+            }
+          ];
+  
+          inquirer.prompt(questions).then((ans) => {
+            // 验证项目名称是否合法
+            const { isValid, errors } = validateProjectName(ans.name);
+            if (!isValid) {
+              console.error(errors.join('\n'));
+              process.exit(1);
+            }
+  
+            if (!ans.name) {
+              console.error('自定义组件项目名称不能为空。');
+              process.exit(1);
+            } else {
+              mainAction.createCmpProjectByTemplate(ans.name);
+            }
+          });
+        }
       }
-    }
-  )
-  .command(
-    'createCmp [options]',
-    '创建自定义组件',
-    (yargs) => {
-      yargs
-        .reset()
-        .usage(titleTip('Usage') + ': $0 preview [options]')
-        .option('name', {
-          alias: 'n',
-          describe: '自定义组件名称'
-        })
-        .alias('h', 'help');
-    },
-    (argv) => {
-      if (argv.name) {
-        mainAction.createCmpByTemplate(argv.name);
-      } else {
-        const questions = [
-          {
-            name: 'name',
-            type: 'input',
-            message: '请设置自定义组件名称:'
-          }
-        ];
-
-        inquirer.prompt(questions).then((ans) => {
-          if (!ans.name) {
-            console.error('自定义组件名称不能为空。');
-            process.exit(1);
-          } else {
-            mainAction.createCmpByTemplate(ans.name);
-          }
-        });
+    )
+    .command(
+      'cmp [options]',
+      '创建自定义组件',
+      (yargs) => {
+        yargs
+          .reset()
+          .usage(titleTip('Usage') + ': $0 cmp [options]')
+          .option('name', {
+            alias: 'n',
+            describe: '自定义组件名称'
+          })
+          .alias('h', 'help');
+      },
+      (argv) => {
+        if (argv.name) {
+          mainAction.createCmpByTemplate(argv.name);
+        } else {
+          const questions = [
+            {
+              name: 'name',
+              type: 'input',
+              message: '请设置自定义组件名称:'
+            }
+          ];
+  
+          inquirer.prompt(questions).then((ans) => {
+            if (!ans.name) {
+              console.error('自定义组件名称不能为空。');
+              process.exit(1);
+            } else {
+              mainAction.createCmpByTemplate(ans.name);
+            }
+          });
+        }
       }
-    }
-  )
+    )
+  })
   .command(
-    'pullCmp [options]',
+    'pull cmp [options]',
     '拉取线上自定义组件',
     (yargs) => {
       yargs
         .reset()
-        .usage(titleTip('Usage') + ': $0 preview [options]')
+        .usage(titleTip('Usage') + ': $0 pull cmp [options]')
         .option('name', {
           alias: 'n',
           describe: '自定义组件名称'
@@ -290,12 +293,12 @@ yargs
     }
   )
   .command(
-    'deleteCmp [options]',
+    'delete cmp [options]',
     '删除线上自定义组件',
     (yargs) => {
       yargs
         .reset()
-        .usage(titleTip('Usage') + ': $0 deleteCmp [options]')
+        .usage(titleTip('Usage') + ': $0 delete cmp [options]')
         .option('name', {
           alias: 'n',
           describe: '自定义组件名称'
@@ -479,12 +482,12 @@ yargs
     }
   )
   .command(
-    'pushCmp [options]',
+    'push cmp [options]',
     '构建并发布自定义组件到 NeoCRM 平台',
     (yargs) => {
       yargs
         .reset()
-        .usage(titleTip('Usage') + ': $0 pushCmp [options]')
+        .usage(titleTip('Usage') + ': $0 push cmp [options]')
         .option('name', {
           alias: 'n',
           describe: '自定义组件名称'
@@ -592,10 +595,10 @@ yargs
     const commands = [
       { cmd: 'init [options]', desc: '根据模板创建一个自定义组件' },
       // { cmd: 'config init', desc: '创建 neo.config.js 配置文件' },
-      { cmd: 'createProject [options]', desc: '创建自定义组件项目（含工程代码）' },
-      { cmd: 'createCmp [options]', desc: '创建自定义组件' },
-      { cmd: 'pullCmp [options]', desc: '拉取线上自定义组件' },
-      { cmd: 'deleteCmp [options]', desc: '删除线上自定义组件' },
+      { cmd: 'create project [options]', desc: '创建自定义组件项目（含工程代码）' },
+      { cmd: 'create cmp [options]', desc: '创建自定义组件' },
+      { cmd: 'pull cmp [options]', desc: '拉取线上自定义组件' },
+      { cmd: 'delete cmp [options]', desc: '删除线上自定义组件' },
       { cmd: 'preview [options]', desc: '预览指定自定义组件（仅预览组件本身内容）' },
       // { cmd: 'dev', desc: '开启本地调试模式' },
       { cmd: 'linkDebug', desc: '开启外链调试模式（在线上页面设计器端调试）' },
@@ -603,7 +606,7 @@ yargs
       // { cmd: 'build2lib', desc: '构建 UMD 模块' },
       // { cmd: 'build2esm', desc: '构建 ESM 模块' },
       // { cmd: 'publish2oss [options]', desc: '发布到oss' },
-      { cmd: 'pushCmp [options]', desc: '构建并发布自定义组件到 NeoCRM 平台' },
+      { cmd: 'push cmp [options]', desc: '构建并发布自定义组件到 NeoCRM 平台' },
       // { cmd: 'inspect', desc: '输出当前配置文件' },
       { cmd: 'open [options]', desc: '使用 Cursor 或 VSCode 打开项目' }
     ];

package/src/template/antd-custom-cmp-template/package.json

@@ -13,7 +13,7 @@
   "scripts": {
     "preview": "neo preview",
     "linkDebug": "neo linkDebug",
-    "pushCmp": "neo pushCmp",
+    "pushCmp": "neo push cmp",
     "format": "prettier --write \"src/**/**/*.{js,jsx,ts,tsx,vue,scss,json}\""
   },
   "files": [
@@ -48,7 +48,7 @@
     "@commitlint/config-conventional": "^9.1.1",
     "@types/react": "^16.9.11",
     "@types/react-dom": "^16.9.15",
-    "neo-cmp-cli": "^1.6.8",
+    "neo-cmp-cli": "^1.7.1",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.9",
     "prettier": "^2.0.5"

package/src/template/echarts-custom-cmp-template/package.json

@@ -13,7 +13,7 @@
   "scripts": {
     "preview": "neo preview",
     "linkDebug": "neo linkDebug",
-    "pushCmp": "neo pushCmp",
+    "pushCmp": "neo push cmp",
     "format": "prettier --write \"src/**/**/*.{js,jsx,ts,tsx,vue,scss,json}\""
   },
   "files": [
@@ -48,7 +48,7 @@
     "@commitlint/config-conventional": "^9.1.1",
     "@types/react": "^16.9.11",
     "@types/react-dom": "^16.9.15",
-    "neo-cmp-cli": "^1.6.8",
+    "neo-cmp-cli": "^1.7.1",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.9",
     "prettier": "^2.0.5",

package/src/template/empty-custom-cmp-template/package.json

@@ -12,7 +12,7 @@
   "scripts": {
     "preview": "neo preview",
     "linkDebug": "neo linkDebug",
-    "pushCmp": "neo pushCmp",
+    "pushCmp": "neo push cmp",
     "format": "prettier --write \"src/**/**/*.{js,jsx,ts,tsx,vue,scss,json}\""
   },
   "files": [
@@ -46,7 +46,7 @@
     "@commitlint/config-conventional": "^9.1.1",
     "@types/react": "^16.9.11",
     "@types/react-dom": "^16.9.15",
-    "neo-cmp-cli": "^1.6.8",
+    "neo-cmp-cli": "^1.7.1",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.9",
     "prettier": "^2.0.5"

package/src/template/neo-custom-cmp-template/package.json

@@ -13,7 +13,7 @@
   "scripts": {
     "preview": "neo preview",
     "linkDebug": "neo linkDebug",
-    "pushCmp": "neo pushCmp",
+    "pushCmp": "neo push cmp",
     "format": "prettier --write \"src/**/**/*.{js,jsx,ts,tsx,vue,scss,json}\""
   },
   "files": [
@@ -52,7 +52,7 @@
     "@types/react": "^16.9.11",
     "@types/react-dom": "^16.9.15",
     "@types/axios": "^0.14.0",
-    "neo-cmp-cli": "^1.6.8",
+    "neo-cmp-cli": "^1.7.1",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.9",
     "prettier": "^2.0.5"

package/src/template/react-custom-cmp-template/package.json

@@ -13,7 +13,7 @@
   "scripts": {
     "preview": "neo preview",
     "linkDebug": "neo linkDebug",
-    "pushCmp": "neo pushCmp",
+    "pushCmp": "neo push cmp",
     "format": "prettier --write \"src/**/**/*.{js,jsx,ts,tsx,vue,scss,json}\""
   },
   "files": [
@@ -45,7 +45,7 @@
   "devDependencies": {
     "@commitlint/cli": "^8.3.5",
     "@commitlint/config-conventional": "^9.1.1",
-    "neo-cmp-cli": "^1.6.8",
+    "neo-cmp-cli": "^1.7.1",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.9",
     "prettier": "^2.0.5"

package/src/template/react-ts-custom-cmp-template/package.json

@@ -13,7 +13,7 @@
   "scripts": {
     "preview": "neo preview",
     "linkDebug": "neo linkDebug",
-    "pushCmp": "neo pushCmp",
+    "pushCmp": "neo push cmp",
     "format": "prettier --write \"src/**/**/*.{js,jsx,ts,tsx,vue,scss,json}\""
   },
   "files": [
@@ -47,7 +47,7 @@
     "@commitlint/config-conventional": "^9.1.1",
     "@types/react": "^16.9.11",
     "@types/react-dom": "^16.9.15",
-    "neo-cmp-cli": "^1.6.8",
+    "neo-cmp-cli": "^1.7.1",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.9",
     "prettier": "^2.0.5"

package/src/template/vue2-custom-cmp-template/package.json

@@ -13,7 +13,7 @@
   "scripts": {
     "preview": "neo preview",
     "linkDebug": "neo linkDebug",
-    "pushCmp": "neo pushCmp",
+    "pushCmp": "neo push cmp",
     "format": "prettier --write \"src/**/**/*.{js,jsx,ts,tsx,vue,scss,json}\""
   },
   "files": [
@@ -45,7 +45,7 @@
   "devDependencies": {
     "@commitlint/cli": "^8.3.5",
     "@commitlint/config-conventional": "^9.1.1",
-    "neo-cmp-cli": "^1.6.8",
+    "neo-cmp-cli": "^1.7.1",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.9",
     "prettier": "^2.0.5",

package/src/utils/cmpUtils/createCmpByTemplate.js

@@ -30,7 +30,7 @@ module.exports = function (cmpName, componentBaseDir = './src/components') {
 
   if (!hasNeoProject()) {
     console.error(
-      `${consoleTag}当前（${process.cwd()}）还不是自定义组件项目，请先创建一个自定义组件项目（neo init / neo createProject）。`
+      `${consoleTag}当前（${process.cwd()}）还不是自定义组件项目，请先创建一个自定义组件项目（neo init / neo create project）。`
     );
     process.exit(1);
   }

package/src/utils/cmpUtils/createCmpByZip.js

@@ -119,7 +119,7 @@ module.exports = async function (cmpZipUrl, cmpName, componentBaseDir = './src/c
 
   if (!hasNeoProject()) {
     errorLog(
-      `当前（${process.cwd()}）还不是自定义组件项目，请先创建一个自定义组件项目（neo init / neo createProject）。`
+      `当前（${process.cwd()}）还不是自定义组件项目，请先创建一个自定义组件项目（neo init / neo create project）。`
     );
     process.exit(1);
   }