neo-cmp-cli 1.7.0 → 1.7.2

package/README.md

@@ -474,8 +474,8 @@ module.exports = {
 ```javascript
 module.exports = {
   neoCommonModule: {
-    // neoExports: ['xxModule'], // 数组写法，可用于导出第三方依赖模块
-    neoExports: { 'xxModule_A': path.resolve('./src/components/xxModule_A') }, // 对象写法，如果导出内容模块，需要使用绝对路径导出
+    // exports: ['xxModule'], // 数组写法，可用于导出第三方依赖模块
+    exports: { 'xxModule_A': path.resolve('./src/components/xxModule_A') }, // 对象写法，如果导出内容模块，需要使用绝对路径导出
   },
 }
 ```
@@ -485,7 +485,7 @@ module.exports = {
 module.exports = {
   neoCommonModule: {
     remoteDeps: ['neo-custom-cmpA'], // 远程自定义组件，表示当前自定义组件 B 会用到的自定义组件
-    neoExternals: ['xxModule_A'], // 自定义组件中需要剔除的模块（远程自定义组件中分享出来的模块），仅支持数组写法，需要和 remoteDeps 配合使用
+    externals: ['xxModule_A'], // 自定义组件中需要剔除的模块（远程自定义组件中分享出来的模块），仅支持数组写法，需要和 remoteDeps 配合使用
   },
 }
 ```

package/package.json

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

package/src/initData/neo.config.js

@@ -41,12 +41,12 @@ module.exports = {
   // 用于添加 Neo 共享依赖模块的配置信息
   /*
   neoCommonModule: {
-    // neoExports: ['xxModule'], // 自定义组件 共享出来的模块，支持数组和对象形式
-    neoExports: { // 对象写法
+    // exports: ['xxModule'], // 自定义组件 共享出来的模块，支持数组和对象形式
+    exports: { // 对象写法
       'xxModule': path.resolve('./src/components/xxModule'), // 导出 xx组件 或 xx模块
     },
-    // remoteDeps: ['xxCmpType'], // 远程依赖组件，表示当前自定义组件会用到的依赖组件，需要和 neoExternals 配合使用
-    // neoExternals: ['xxModule'], // 自定义组件中需要剔除的模块，仅支持数组写法
+    // remoteDeps: ['xxCmpType'], // 远程依赖组件，表示当前自定义组件会用到的依赖组件，需要和 externals 配合使用
+    // externals: ['xxModule'], // 自定义组件中需要剔除的模块，仅支持数组写法
   },
   */
   preview: {

package/src/module/index.js

@@ -161,92 +161,95 @@ yargs
       neoConfigInit('neo.config.js');
     }
   )
-  .command(
-    'create project [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(
-    'create cmp [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(
     'pull cmp [options]',
     '拉取线上自定义组件',
     (yargs) => {
       yargs
         .reset()
-        .usage(titleTip('Usage') + ': $0 preview [options]')
+        .usage(titleTip('Usage') + ': $0 pull cmp [options]')
         .option('name', {
           alias: 'n',
           describe: '自定义组件名称'
@@ -295,7 +298,7 @@ yargs
     (yargs) => {
       yargs
         .reset()
-        .usage(titleTip('Usage') + ': $0 deleteCmp [options]')
+        .usage(titleTip('Usage') + ': $0 delete cmp [options]')
         .option('name', {
           alias: 'n',
           describe: '自定义组件名称'
@@ -484,7 +487,7 @@ yargs
     (yargs) => {
       yargs
         .reset()
-        .usage(titleTip('Usage') + ': $0 pushCmp [options]')
+        .usage(titleTip('Usage') + ': $0 push cmp [options]')
         .option('name', {
           alias: 'n',
           describe: '自定义组件名称'

package/src/module/main.js

@@ -26,7 +26,7 @@ const getValue = (originValue, defaultValue) => {
 
 const neoCommonModule = curConfig.neoCommonModule || {};
 // 自定义组件 需要剔除的依赖模块
-const cmpNeoExternals = neoCommonModule.neoExternals || [];
+const cmpNeoExternals = neoCommonModule.externals || [];
 
 /**
  * 添加 AddNeoRequirePlugin 到 webpack 配置
@@ -51,11 +51,11 @@ function addNeoRequirePlugin(webpackConfig, options = {}) {
  * @param {object} externalsConfig 现有的 externals 配置
  */
 function addNeoExternals(config, externalsConfig) {
-  const neoExternals = getExternalsByNeoCommonModules(cmpNeoExternals);
+  const externals = getExternalsByNeoCommonModules(cmpNeoExternals);
   if (externalsConfig && _.isPlainObject(externalsConfig)) {
-    config.externals = Object.assign(externalsConfig, neoExternals);
+    config.externals = Object.assign(externalsConfig, externals);
   } else {
-    config.externals = neoExternals;
+    config.externals = externals;
   }
 }
 

package/src/neo/neoRequire.js

@@ -24,19 +24,19 @@ const NeoCommonModules = {
 
 // 根据 Neo 共享出来的依赖模块，获取 externals 配置
 const getExternalsByNeoCommonModules = (cmpNeoExternals) => {
-  const neoExternals = {};
+  const externals = {};
   Object.keys(NeoCommonModules).forEach(moduleName => {
-    neoExternals[moduleName] = `commonjs ${moduleName}`;
+    externals[moduleName] = `commonjs ${moduleName}`;
   });
 
-  // 如果自定义组件有共享的依赖模块，则合并到 neoExternals 中
+  // 如果自定义组件有共享的依赖模块，则合并到 externals 中
   if (cmpNeoExternals && cmpNeoExternals.length > 0) {
     cmpNeoExternals.forEach(moduleName => {
-      neoExternals[moduleName] = `commonjs ${moduleName}`;
+      externals[moduleName] = `commonjs ${moduleName}`;
     });
   }
   
-  return neoExternals;
+  return externals;
 };
 
 // 用于添加共享的依赖模块

package/src/template/antd-custom-cmp-template/neo.config.js

@@ -41,12 +41,12 @@ module.exports = {
   // 用于添加 Neo 共享依赖模块和剔除模块
   /*
   neoCommonModule: {
-    // neoExports: ['xxModule'], // 自定义组件 共享出来的模块，支持数组和对象形式
-    neoExports: { // 对象写法
+    // exports: ['xxModule'], // 自定义组件 共享出来的模块，支持数组和对象形式
+    exports: { // 对象写法
       'xxModule': path.resolve('./src/components/xxModule'), // 导出 xx组件 或 xx模块
     },
-    // remoteDeps: ['xxCmpType'], // 远程依赖组件，表示当前自定义组件会用到的依赖组件，需要和 neoExternals 配合使用
-    // neoExternals: ['xxModule'], // 自定义组件中需要剔除的模块（仅支持数组写法）
+    // remoteDeps: ['xxCmpType'], // 远程依赖组件，表示当前自定义组件会用到的依赖组件，需要和 externals 配合使用
+    // externals: ['xxModule'], // 自定义组件中需要剔除的模块（仅支持数组写法）
   },
   */
   preview: {

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

@@ -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.7.0",
+    "neo-cmp-cli": "^1.7.2",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.9",
     "prettier": "^2.0.5"

package/src/template/develop/neo-custom-cmp-template/neo.config.js

@@ -41,13 +41,13 @@ module.exports = {
   // 用于添加 Neo 共享依赖模块的配置信息
   /*
   neoCommonModule: {
-    // neoExports: ['xxModule'], // 自定义组件 共享出来的模块，支持数组和对象形式
-    neoExports: { // 对象写法
+    // exports: ['xxModule'], // 自定义组件 共享出来的模块，支持数组和对象形式
+    exports: { // 对象写法
       'chart-widget': path.resolve('./src/components/chart-widget'), // 导出图表自定义组件
       'neo-register': 'neo-register', // 导出 Neo 注册模块
     },
-    // remoteDeps: ['xxModule'], // 远程依赖组件，表示当前自定义组件会用到的远程依赖组件，需要和 neoExternals 配合使用
-    // neoExternals: ['xxModule'], // 自定义组件中需要剔除的模块，仅支持数组写法
+    // remoteDeps: ['xxModule'], // 远程依赖组件，表示当前自定义组件会用到的远程依赖组件，需要和 externals 配合使用
+    // externals: ['xxModule'], // 自定义组件中需要剔除的模块，仅支持数组写法
   },
   */
   preview: {

package/src/template/echarts-custom-cmp-template/neo.config.js

@@ -41,14 +41,14 @@ module.exports = {
   // 用于添加 Neo 共享依赖模块的配置信息
   ///*
   neoCommonModule: {
-    // neoExports: ['xxModule'], // 自定义组件 共享出来的模块，支持数组和对象形式
-    neoExports: {
+    // exports: ['xxModule'], // 自定义组件 共享出来的模块，支持数组和对象形式
+    exports: {
       // 对象写法
       'chart-widget': path.resolve('./src/components/chart-widget'), // 导出图表自定义组件
       'neo-register': 'neo-register', // 导出 Neo 注册模块
     },
-    // remoteDeps: ['xxCmpType'], // 远程依赖组件，表示当前自定义组件会用到的依赖组件，需要和 neoExternals 配合使用
-    // neoExternals: ['xxModule'], // 自定义组件中需要剔除的模块，仅支持数组写法
+    // remoteDeps: ['xxCmpType'], // 远程依赖组件，表示当前自定义组件会用到的依赖组件，需要和 externals 配合使用
+    // externals: ['xxModule'], // 自定义组件中需要剔除的模块，仅支持数组写法
   },
   //*/
   preview: {

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

@@ -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.7.0",
+    "neo-cmp-cli": "^1.7.2",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.9",
     "prettier": "^2.0.5",

package/src/template/empty-custom-cmp-template/neo.config.js

@@ -41,12 +41,12 @@ module.exports = {
   // 用于添加 Neo 共享依赖模块的配置信息
   /*
   neoCommonModule: {
-    // neoExports: ['xxModule'], // 自定义组件 共享出来的模块，支持数组和对象形式
-    neoExports: { // 对象写法
+    // exports: ['xxModule'], // 自定义组件 共享出来的模块，支持数组和对象形式
+    exports: { // 对象写法
       'xxModule': path.resolve('./src/components/xxModule'), // 导出 xx组件 或 xx模块
     },
-    // remoteDeps: ['xxCmpType'], // 远程依赖组件，表示当前自定义组件会用到的依赖组件，需要和 neoExternals 配合使用
-    // neoExternals: ['xxModule'], // 自定义组件中需要剔除的模块，仅支持数组写法
+    // remoteDeps: ['xxCmpType'], // 远程依赖组件，表示当前自定义组件会用到的依赖组件，需要和 externals 配合使用
+    // externals: ['xxModule'], // 自定义组件中需要剔除的模块，仅支持数组写法
   },
   */
   preview: {

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

@@ -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.7.0",
+    "neo-cmp-cli": "^1.7.2",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.9",
     "prettier": "^2.0.5"

package/src/template/neo-custom-cmp-template/neo.config.js

@@ -49,12 +49,12 @@ module.exports = {
   // 用于添加 Neo 共享依赖模块的配置信息
   /*
   neoCommonModule: {
-    // neoExports: ['xxModule'], // 自定义组件 共享出来的模块，支持数组和对象形式
-    neoExports: { // 对象写法
+    // exports: ['xxModule'], // 自定义组件 共享出来的模块，支持数组和对象形式
+    exports: { // 对象写法
       'xxModule': path.resolve('./src/components/xxModule'), // 导出 xx组件 或 xx模块
     },
-    // remoteDeps: ['xxCmpType'], // 远程依赖组件，表示当前自定义组件会用到的依赖组件，需要和 neoExternals 配合使用
-    // neoExternals: ['xxModule'], // 自定义组件中需要剔除的模块，仅支持数组写法
+    // remoteDeps: ['xxCmpType'], // 远程依赖组件，表示当前自定义组件会用到的依赖组件，需要和 externals 配合使用
+    // externals: ['xxModule'], // 自定义组件中需要剔除的模块，仅支持数组写法
   },
   */
   preview: {

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

@@ -52,7 +52,7 @@
     "@types/react": "^16.9.11",
     "@types/react-dom": "^16.9.15",
     "@types/axios": "^0.14.0",
-    "neo-cmp-cli": "^1.7.0",
+    "neo-cmp-cli": "^1.7.2",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.9",
     "prettier": "^2.0.5"

package/src/template/react-custom-cmp-template/neo.config.js

@@ -45,12 +45,12 @@ module.exports = {
   // 用于添加 Neo 共享依赖模块的配置信息
   /*
   neoCommonModule: {
-    // neoExports: ['xxModule'], // 自定义组件 共享出来的模块，支持数组和对象形式
-    neoExports: { // 对象写法
+    // exports: ['xxModule'], // 自定义组件 共享出来的模块，支持数组和对象形式
+    exports: { // 对象写法
       'xxModule': path.resolve('./src/components/xxModule'), // 导出 xx组件 或 xx模块
     },
-    // remoteDeps: ['xxCmpType'], // 远程依赖组件，表示当前自定义组件会用到的依赖组件，需要和 neoExternals 配合使用
-    // neoExternals: ['xxModule'], // 自定义组件中需要剔除的模块，仅支持数组写法
+    // remoteDeps: ['xxCmpType'], // 远程依赖组件，表示当前自定义组件会用到的依赖组件，需要和 externals 配合使用
+    // externals: ['xxModule'], // 自定义组件中需要剔除的模块，仅支持数组写法
   },
   */
   preview: {

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

@@ -45,7 +45,7 @@
   "devDependencies": {
     "@commitlint/cli": "^8.3.5",
     "@commitlint/config-conventional": "^9.1.1",
-    "neo-cmp-cli": "^1.7.0",
+    "neo-cmp-cli": "^1.7.2",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.9",
     "prettier": "^2.0.5"

package/src/template/react-ts-custom-cmp-template/neo.config.js

@@ -41,12 +41,12 @@ module.exports = {
   // 用于添加 Neo 共享依赖模块的配置信息
   /*
   neoCommonModule: {
-    // neoExports: ['xxModule'], // 自定义组件 共享出来的模块，支持数组和对象形式
-    neoExports: { // 对象写法
+    // exports: ['xxModule'], // 自定义组件 共享出来的模块，支持数组和对象形式
+    exports: { // 对象写法
       'xxModule': path.resolve('./src/components/xxModule'), // 导出 xx组件 或 xx模块
     },
-    // remoteDeps: ['xxCmpType'], // 远程依赖组件，表示当前自定义组件会用到的依赖组件，需要和 neoExternals 配合使用
-    // neoExternals: ['xxModule'], // 自定义组件中需要剔除的模块，仅支持数组写法
+    // remoteDeps: ['xxCmpType'], // 远程依赖组件，表示当前自定义组件会用到的依赖组件，需要和 externals 配合使用
+    // externals: ['xxModule'], // 自定义组件中需要剔除的模块，仅支持数组写法
   },
   */
   preview: {

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

@@ -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.7.0",
+    "neo-cmp-cli": "^1.7.2",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.9",
     "prettier": "^2.0.5"

package/src/template/vue2-custom-cmp-template/neo.config.js

@@ -50,12 +50,12 @@ module.exports = {
   // 用于添加 Neo 共享依赖模块的配置信息
   /*
   neoCommonModule: {
-    // neoExports: ['xxModule'], // 自定义组件 共享出来的模块，支持数组和对象形式
-    neoExports: { // 对象写法
+    // exports: ['xxModule'], // 自定义组件 共享出来的模块，支持数组和对象形式
+    exports: { // 对象写法
       'xxModule': path.resolve('./src/components/xxModule'), // 导出 xx组件 或 xx模块
     },
-    // remoteDeps: ['xxCmpType'], // 远程依赖组件，表示当前自定义组件会用到的依赖组件，需要和 neoExternals 配合使用
-    // neoExternals: ['xxModule'], // 自定义组件中需要剔除的模块，仅支持数组写法
+    // remoteDeps: ['xxCmpType'], // 远程依赖组件，表示当前自定义组件会用到的依赖组件，需要和 externals 配合使用
+    // externals: ['xxModule'], // 自定义组件中需要剔除的模块，仅支持数组写法
   },
   */
   preview: {

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

@@ -45,7 +45,7 @@
   "devDependencies": {
     "@commitlint/cli": "^8.3.5",
     "@commitlint/config-conventional": "^9.1.1",
-    "neo-cmp-cli": "^1.7.0",
+    "neo-cmp-cli": "^1.7.2",
     "husky": "^4.2.5",
     "lint-staged": "^10.2.9",
     "prettier": "^2.0.5",

package/src/utils/cmpUtils/createCommonModulesCode.js

@@ -9,9 +9,9 @@ const { isPlainObject } = require('lodash');
  * @returns 组件预览代码
  */
 const createCommonModulesCode = (neoCommonModule, cmpTypes) => {
-  const { neoExports, remoteDeps } = neoCommonModule;
+  const { exports, remoteDeps } = neoCommonModule;
 
-  if (!neoExports && !remoteDeps) {
+  if (!exports && !remoteDeps) {
     return '';
   }
   // 记录当前自定义组件共享出去的模块
@@ -19,18 +19,18 @@ const createCommonModulesCode = (neoCommonModule, cmpTypes) => {
   // 记录当前自定义组件需要的远程依赖组件
   const CustomCmpRemoteDeps = {};
 
-  // 根据 neoExports 获取共享的依赖模块
-  if (Array.isArray(neoExports) && neoExports.length > 0) {
-    neoExports.forEach((module) => {
+  // 根据 exports 获取共享的依赖模块
+  if (Array.isArray(exports) && exports.length > 0) {
+    exports.forEach((module) => {
       CustomCmpCommonModules[module] = require(module);
     });
-  } else if (isPlainObject(neoExports) && Object.keys(neoExports).length > 0) {
-    Object.keys(neoExports).forEach((moduleId) => {
-      CustomCmpCommonModules[moduleId] = `require('${neoExports[moduleId]}')`;
+  } else if (isPlainObject(exports) && Object.keys(exports).length > 0) {
+    Object.keys(exports).forEach((moduleId) => {
+      CustomCmpCommonModules[moduleId] = `require('${exports[moduleId]}')`;
     });
-  } else if (neoExports) {
+  } else if (exports) {
     console.error(
-      'neoExports 格式不正确，请检查 neo.config.js 文件中的 neoCommonModule / neoExports 配置'
+      'exports 格式不正确，请检查 neo.config.js 文件中的 neoCommonModule / exports 配置'
     );
     process.exit(1);
   }