neo-cmp-cli 1.3.10 → 1.5.0-beta.10

package/src/module/index.js

@@ -9,6 +9,7 @@ const inspect = require('./inspect.js'); // 输出当前项目配置文件
 const neoConfigInit = require('../utils/neoConfigInit.js');
 const { validateProjectName } = require('../utils/projectNameValidator.js');
 const mainAction = require('./main.js'); // 入口文件
+const getCmpTypeByDir = require('../cmpUtils/getCmpTypeByDir.js');
 
 // neo 的 package 文件
 const neoPackage = require('../../package.json');
@@ -81,11 +82,14 @@ yargs
             value: 'neo',
             short: 'neo'
           },
+          /*
+          // 暂不提供 react js 模板（react js 模板已废弃）
           {
             name: 'react 自定义组件',
             value: 'react',
             short: 'react'
           },
+          */
           {
             name: 'vue2 自定义组件',
             value: 'vue2',
@@ -148,6 +152,81 @@ 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 {
+        questions.push({
+          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(errors.join('\n'));
+            process.exit(1);
+          } else {
+            mainAction.createCmpProjectByTemplate(argv.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 {
+        questions.push({
+          name: 'name',
+          type: 'input',
+          message: '请设置自定义组件名称:',
+        });
+
+        inquirer.prompt(questions).then((ans) => {
+          if (!ans.name) {
+            console.error('自定义组件名称不能为空。');
+            process.exit(1);
+          } else {
+            mainAction.createCmpByTemplate(argv.name);
+          }
+        });
+      }
+    }
+  )
   .command(
     'preview [options]',
     '预览指定自定义组件（仅预览组件本身内容）',
@@ -155,25 +234,38 @@ yargs
       yargs
         .reset()
         .usage(titleTip('Usage') + ': $0 preview [options]')
-        .option('cmpType', {
-          alias: 't',
-          describe: '自定义组件项目名称'
+        .option('name', {
+          alias: 'n',
+          describe: '自定义组件名称'
         })
         .alias('h', 'help');
     },
     (argv) => {
-      if (argv.cmpType) {
-        mainAction.previewCmp(argv.cmpType);
+      if (argv.name) {
+        mainAction.previewCmp(argv.name);
       } else {
+        const cmpTypes = getCmpTypeByDir();
+        if (cmpTypes.length === 0) {
+          console.error('当前自定义组件目录中未找到自定义组件。（./src/components 目录下）');
+          process.exit(1);
+        }
+        const cmpTypeChoices = cmpTypes.map((cmpType) => ({
+          name: cmpType,
+          value: cmpType
+        }));
         const questions = [
           {
             name: 'cmpType',
-            type: 'input',
-            message: '请输入要预览的自定义组件名称（默认 info-card）:',
-            default: 'info-card'
+            type: 'list',
+            message: '请选择要预览的自定义组件:',
+            choices: cmpTypeChoices
           }
         ];
         inquirer.prompt(questions).then((ans) => {
+          if (!ans.cmpType) {
+            console.error('未选择要预览的自定义组件。');
+            process.exit(1);
+          }
           mainAction.previewCmp(ans.cmpType);
         });
       }
@@ -238,14 +330,85 @@ yargs
       yargs
         .reset()
         .usage(titleTip('Usage') + ': $0 publish2oss [options]')
-        .option('cmpType', {
-          alias: 't',
+        .option('name', {
+          alias: 'n',
           describe: '自定义组件名称'
         })
         .alias('h', 'help');
     },
     (argv) => {
-      mainAction.publish2oss(argv.cmpType); // 构建并发布脚本到oss
+      if (argv.name) {
+        mainAction.publish2oss(argv.name); // 构建并发布脚本到oss
+      } else {
+        const cmpTypes = getCmpTypeByDir();
+        if (cmpTypes.length === 0) {
+          console.error('当前自定义组件目录中未找到自定义组件。（./src/components 目录下）');
+          process.exit(1);
+        }
+        const cmpTypeChoices = cmpTypes.map((cmpType) => ({
+          name: cmpType,
+          value: cmpType
+        }));
+        const questions = [
+          {
+            name: 'cmpType',
+            type: 'list',
+            message: '请选择要发布的自定义组件:',
+            choices: cmpTypeChoices
+          }
+        ];
+        inquirer.prompt(questions).then((ans) => {
+          if (!ans.cmpType) {
+            console.error('未选择要发布的自定义组件。');
+            process.exit(1);
+          }
+          mainAction.publish2oss(ans.cmpType);
+        });
+      }
+    }
+  )
+  .command(
+    'pushCmp [options]',
+    '发布组件到 NeoCRM 平台',
+    (yargs) => {
+      yargs
+        .reset()
+        .usage(titleTip('Usage') + ': $0 pushCmp [options]')
+        .option('name', {
+          alias: 'n',
+          describe: '自定义组件名称'
+        })
+        .alias('h', 'help');
+    },
+    (argv) => {
+      if (argv.name) {
+        mainAction.pushCmp(argv.name); // 构建并发布组件到 NeoCRM
+      } else {
+        const cmpTypes = getCmpTypeByDir();
+        if (cmpTypes.length === 0) {
+          console.error('当前自定义组件目录中未找到自定义组件。（./src/components 目录下）');
+          process.exit(1);
+        }
+        const cmpTypeChoices = cmpTypes.map((cmpType) => ({
+          name: cmpType,
+          value: cmpType
+        }));
+        const questions = [
+          {
+            name: 'cmpType',
+            type: 'list',
+            message: '请选择要发布的自定义组件:',
+            choices: cmpTypeChoices
+          }
+        ];
+        inquirer.prompt(questions).then((ans) => {
+          if (!ans.cmpType) {
+            console.error('未选择要发布的自定义组件。');
+            process.exit(1);
+          }
+          mainAction.pushCmp(ans.cmpType);
+        });
+      }
     }
   )
   .command(

package/src/module/main.js

@@ -7,13 +7,16 @@ const neoConfigInit = require('../utils/neoConfigInit.js');
 const { consoleTag } = require('../utils/neoParams');
 const curConfig = require('../config/index'); // 获取当前项目根目录下的配置文件
 const publish2oss = require('../oss/publish2oss');
-const getEntries = require('../cmpUtils/getEntries');
-const getEntriesWithAutoRegister = require('../cmpUtils/getEntriesWithAutoRegister');
-const previewCmp = require('./previewCmp');
+const pushCmp = require('../cmpUtils/pushCmp');
+const previewCmp = require('../cmpUtils/previewCmp');
+const getEntries = require('../projectUtils/getEntries');
+const getEntriesWithAutoRegister = require('../projectUtils/getEntriesWithAutoRegister');
 const AddNeoRequirePlugin = require('../plugins/AddNeoRequirePlugin');
 const { getExternalsByNeoCommonModules } = require('../neo/neoRequire');
 // const { MFPlugins } = require('../neo/webpack.mf');
 const createCommonModulesCode = require('../cmpUtils/createCommonModulesCode');
+const createCmpByTemplate = require('../cmpUtils/createCmpByTemplate');
+const createCmpProjectByTemplate = require('../projectUtils/createCmpProjectByTemplate');
 
 const getValue = (originValue, defaultValue) => {
   return originValue !== undefined ? originValue : defaultValue;
@@ -28,6 +31,8 @@ module.exports = {
   neoInitByCopy,
   inspect,
   neoConfigInit,
+  createCmpProjectByTemplate,
+  createCmpByTemplate,
   dev: () => {
     if (!curConfig.dev) {
       console.error('未找到 dev 相关配置。');
@@ -270,5 +275,93 @@ module.exports = {
       );
     });
   },
+  // 发布组件到 NeoCRM 平台
+  pushCmp: (cmpType) => {
+    // 将 pushCmp 相关配置设置给 build2lib
+    const pushCmpConfig = curConfig.pushCmp;
+    curConfig.build2lib = Object.assign(curConfig.build2lib, pushCmpConfig);
+
+    const curEntry = curConfig.build2lib.entry;
+    let curCmpTypes = [];
+
+    if (!curEntry || Object.keys(curEntry).length === 0) {
+      // 如果未配置 entry，则自动生成 entry
+      let entries = {};
+      if (curConfig.build2lib.disableAutoRegister) {
+        // disableAutoRegister 为 true 时，仅自动生成入口文件（不自动注册）
+        const { widgetEntries, cmpTypes } = getEntries(curConfig.componentsDir, cmpType);
+        entries = widgetEntries;
+        curCmpTypes = cmpTypes;
+      } else {
+        // 自动生成入口文件（并自动创建对应的注册文件）
+        const { widgetEntries, cmpTypes } = getEntriesWithAutoRegister(
+          curConfig.componentsDir,
+          cmpType
+        );
+        entries = widgetEntries;
+        curCmpTypes = cmpTypes;
+      }
+
+      // 注入 webpack/entry
+      if (entries && Object.keys(entries).length > 0) {
+        curConfig.build2lib.entry = entries;
+        console.info('已自动生成 entry 入口配置：', entries);
+      } else {
+        console.error(
+          `未识别到自定义组件，请检查 ${
+            curConfig.componentsDir || './src/components'
+          } 目录下是否存在自定义组件。`
+        );
+        process.exit(1);
+      }
+    }
+
+    /*
+    // 说明：自定义组件和平台模块联邦使用异常，所以暂时注释掉
+    // 添加模块联邦插件
+    if (curConfig.pushCmp.enableMF) {
+      curConfig.webpack.plugins.push(...MFPlugins);
+    }
+    */
+
+    // 添加自定义 webpack 插件: 用于实现和 Neo 平台共享依赖
+    if (
+      curConfig.webpack &&
+      curConfig.webpack.plugins &&
+      Array.isArray(curConfig.webpack.plugins)
+    ) {
+      curConfig.webpack.plugins.push(new AddNeoRequirePlugin());
+    } else {
+      curConfig.webpack.plugins = [new AddNeoRequirePlugin()];
+    }
+
+    // 添加 内置 Neo 的 externals 配置
+    const neoExternals = getExternalsByNeoCommonModules(cmpNeoExternals);
+    if (curConfig.build2lib.externals && _.isPlainObject(curConfig.build2lib.externals)) {
+      curConfig.build2lib.externals = Object.assign(curConfig.build2lib.externals, neoExternals);
+    } else {
+      curConfig.build2lib.externals = neoExternals;
+    }
+
+    // 写入自定义组件的共享模块和远程模块相关信息
+    const commonModulesFilePath = createCommonModulesCode(neoCommonModule, curCmpTypes);
+
+    // 所有入口文件添加 commonModulesFile
+    if (commonModulesFilePath && curConfig.build2lib.entry) {
+      Object.keys(curConfig.build2lib.entry).forEach((name) => {
+        // 判断不是以Model结尾的文件
+        if (!name.endsWith('Model')) {
+          curConfig.build2lib.entry[name] = [commonModulesFilePath].concat(
+            curConfig.build2lib.entry[name]
+          );
+        }
+      });
+    }
+
+    akfun.build('lib', curConfig, consoleTag, () => {
+      // 构建完成后，执行 pushCmp
+      pushCmp(pushCmpConfig, cmpType);
+    });
+  },
   build2esm: (fileName) => akfun.build2esm(fileName, curConfig, consoleTag) // 构建esm输出模块
 };

package/src/module/neoInit.js

@@ -2,6 +2,7 @@ const { gitClone } = require('akfun');
 const { consoleTag } = require('../utils/neoParams'); // 输出标记
 const { replaceInPackage } = require('../utils/replaceInPackage');
 const { resetPackageVersion } = require('../utils/resetPackageVersion');
+const autoEntryRootDir = require('../utils/autoEntryRootDir');
 
 const templateList = {
   react: {
@@ -43,6 +44,8 @@ const neoInit = function (type, projectName) {
       replaceInPackage(finalProjectPath, 'wibetter', 'xxx');
       replaceInPackage(finalProjectPath, 'neo自定义组件模板', 'neo自定义组件');
       resetPackageVersion(finalProjectPath);
+      // 自动切换到项目根目录
+      autoEntryRootDir(finalProjectPath);
     },
     consoleTag
   );

package/src/module/neoInitByCopy.js

@@ -3,6 +3,7 @@ const path = require('path');
 const { consoleTag } = require('../utils/neoParams'); // 输出标记
 const { replaceInPackage } = require('../utils/replaceInPackage');
 const { resetPackageVersion } = require('../utils/resetPackageVersion');
+const autoEntryRootDir = require('../utils/autoEntryRootDir');
 
 const templateList = {
   react: {
@@ -50,6 +51,8 @@ const neoInitByCopy = function (type, projectName) {
       resetPackageVersion(finalProjectPath);
 
       console.log(`${consoleTag}已创建自定义组件（${finalProjectName}）!`);
+      // 自动切换到项目根目录
+      autoEntryRootDir(finalProjectPath);
     })
     .catch((err) => console.error(`${consoleTag}自定义组件模板下载失败：`, err));
 };

package/src/neo/NeoUMDContent.js

@@ -0,0 +1,29 @@
+/**
+ * 内置 UMD 模块，用于在 Node cli 端加载自定义组件模型
+ * 特别说明：这个文件内容会通过 AddNeoRequirePlugin 插入的构建代码中。
+ */
+(function (root, factory) {
+  // AMD 环境检测
+  if (typeof define === 'function' && define.amd) {
+    define([], factory);
+  }
+  // CommonJS 环境检测
+  else if (typeof exports === 'object' && typeof exports.nodeName !== 'string') {
+    module.exports = factory();
+  }
+  // 浏览器全局变量
+  else {
+    root.NeoCustomCmpModel = factory();
+  }
+}(typeof self !== 'undefined' ? self : this, function () {
+  'use strict';
+  
+  const getCustomModels = (cmpType) => {
+    // 自定义组件模型列表
+    const NEOEditorCustomModels = window.NEOEditorCustomModels || {};
+    return NEOEditorCustomModels[cmpType] || {};
+  }
+  
+  // 导出模块
+  return getCustomModels;
+}));

package/src/neo/neoRequire.js

@@ -67,16 +67,16 @@ const addNeoCommonModules = (modules) => {
   }
 }
 
-// 用于添加自定义组件的远程组件
-const addNeoRemotes = (remotes) => {
+// 用于添加自定义组件的远程依赖组件
+const addNeoRemoteDeps = (remoteDeps) => {
   if (!window.__NeoCommonModules) {
     window.__NeoCommonModules = {}
   }
-  if (!window.__NeoCommonModules.__neoRemotes) {
-    window.__NeoCommonModules.__neoRemotes = {}
+  if (!window.__NeoCommonModules.__neoRemoteDeps) {
+    window.__NeoCommonModules.__neoRemoteDeps = {}
   }
-  if (_.isPlainObject(remotes)) {
-    window.__NeoCommonModules.__neoRemotes = Object.assign(window.__NeoCommonModules.__neoRemotes, remotes);
+  if (_.isPlainObject(remoteDeps)) {
+    window.__NeoCommonModules.__neoRemoteDeps = Object.assign(window.__NeoCommonModules.__neoRemoteDeps, remoteDeps);
   }
 }
 
@@ -110,6 +110,6 @@ const neoRequire = (moduleName) => {
 module.exports = {
   initNeoRequire,
   addNeoCommonModules,
-  addNeoRemotes,
+  addNeoRemoteDeps,
   getExternalsByNeoCommonModules
 };