neo-cmp-cli 1.5.6 → 1.6.0-beta.3

package/src/module/main.js

@@ -7,16 +7,16 @@ const neoConfigInit = require('../utils/neoConfigInit.js');
 const { consoleTag } = require('../utils/neoParams');
 const curConfig = require('../config/index'); // 获取当前项目根目录下的配置文件
 const publish2oss = require('../oss/publish2oss');
-const pushCmp = require('../cmpUtils/pushCmp');
-const previewCmp = require('../cmpUtils/previewCmp');
-const getEntries = require('../projectUtils/getEntries');
-const getEntriesWithAutoRegister = require('../projectUtils/getEntriesWithAutoRegister');
+const pushCmp = require('../utils/cmpUtils/pushCmp');
+const previewCmp = require('../utils/cmpUtils/previewCmp');
+const generateEntries = require('../utils/generateEntries');
 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 createCommonModulesCode = require('../utils/cmpUtils/createCommonModulesCode');
+const createCmpByTemplate = require('../utils/cmpUtils/createCmpByTemplate');
+const createCmpProjectByTemplate = require('../utils/projectUtils/createCmpProjectByTemplate');
+const pullCmp = require('../utils/cmpUtils/pullCmp');
 
 const getValue = (originValue, defaultValue) => {
   return originValue !== undefined ? originValue : defaultValue;
@@ -26,6 +26,124 @@ const neoCommonModule = curConfig.neoCommonModule || {};
 // 自定义组件 需要剔除的依赖模块
 const cmpNeoExternals = neoCommonModule.neoExternals || [];
 
+/**
+ * 添加 AddNeoRequirePlugin 到 webpack 配置
+ * @param {object} webpackConfig webpack 配置对象
+ * @param {object} [options] 选项
+ * @param {boolean} [options.verbose] 是否启用详细日志，默认为 false
+ */
+function addNeoRequirePlugin(webpackConfig, options = {}) {
+  const { verbose = false } = options;
+  const plugin = new AddNeoRequirePlugin({ verbose });
+
+  if (webpackConfig && webpackConfig.plugins && Array.isArray(webpackConfig.plugins)) {
+    webpackConfig.plugins.push(plugin);
+  } else {
+    webpackConfig.plugins = [plugin];
+  }
+}
+
+/**
+ * 添加 Neo externals 配置
+ * @param {object} config 配置对象（dev 或 build2lib）
+ * @param {object} externalsConfig 现有的 externals 配置
+ */
+function addNeoExternals(config, externalsConfig) {
+  const neoExternals = getExternalsByNeoCommonModules(cmpNeoExternals);
+  if (externalsConfig && _.isPlainObject(externalsConfig)) {
+    config.externals = Object.assign(externalsConfig, neoExternals);
+  } else {
+    config.externals = neoExternals;
+  }
+}
+
+/**
+ * 创建并注入 commonModulesCode 到 entry
+ * @param {object} config 配置对象（dev 或 build2lib）
+ * @param {array} cmpTypes 组件类型列表
+ * @param {object} [options] 选项
+ * @param {boolean} [options.excludeModel] 是否排除 Model 结尾的 entry，默认为 false
+ */
+function injectCommonModulesCode(config, cmpTypes, options = {}) {
+  const { excludeModel = false } = options;
+  const commonModulesFilePath = createCommonModulesCode(neoCommonModule, cmpTypes);
+
+  if (commonModulesFilePath && config.entry) {
+    Object.keys(config.entry).forEach((name) => {
+      // 如果 excludeModel 为 true，排除 Model 结尾的文件
+      if (!excludeModel || !name.endsWith('Model')) {
+        config.entry[name] = [commonModulesFilePath].concat(config.entry[name]);
+      }
+    });
+  }
+}
+
+/**
+ * 生成并设置 entry 配置
+ * @param {object} config 配置对象（dev 或 build2lib）
+ * @param {object} options 生成选项
+ * @param {string} options.entryType entry 类型：'widget' | 'linkDebug'
+ * @param {string} [options.cmpType] 可选的组件类型
+ * @param {boolean} [options.forceGetCmpTypes] 是否强制获取 cmpTypes
+ * @returns {array} cmpTypes 组件类型列表
+ */
+function setupEntries(config, options) {
+  const { entryType, cmpType, forceGetCmpTypes = false } = options;
+
+  let cmpTypes = [];
+  try {
+    const { entries, cmpTypes: generatedCmpTypes } = generateEntries({
+      configEntry: config.entry,
+      disableAutoRegister: config.disableAutoRegister,
+      componentsDir: curConfig.componentsDir,
+      entryType,
+      cmpType,
+      forceGetCmpTypes
+    });
+
+    if (entries && Object.keys(entries).length > 0) {
+      config.entry = entries;
+      cmpTypes = generatedCmpTypes;
+      console.info('已自动生成 entry 入口配置：', entries);
+    }
+  } catch (error) {
+    console.error(error.message);
+    process.exit(1);
+  }
+
+  return cmpTypes;
+}
+
+/**
+ * 准备 build2lib 配置（用于 publish2oss 和 pushCmp）
+ * @param {object} sourceConfig 源配置对象
+ * @returns {object} 合并后的配置对象
+ */
+function prepareBuild2LibConfig(sourceConfig) {
+  return Object.assign(curConfig.build2lib, sourceConfig);
+}
+
+/**
+ * 配置 webpack 插件、externals 和 commonModulesCode（用于 linkDebug、publish2oss、pushCmp）
+ * @param {object} config 配置对象（dev 或 build2lib）
+ * @param {array} cmpTypes 组件类型列表
+ * @param {object} [options] 选项
+ * @param {boolean} [options.verbose] 是否启用详细日志，默认为 false
+ * @param {boolean} [options.excludeModel] 是否排除 Model 结尾的 entry，默认为 false
+ */
+function configureNeoBuild(config, cmpTypes, options = {}) {
+  const { verbose = false, excludeModel = false } = options;
+
+  // 添加自定义 webpack 插件
+  addNeoRequirePlugin(curConfig.webpack, { verbose });
+
+  // 添加内置 Neo 的 externals 配置
+  addNeoExternals(config, config.externals);
+
+  // 创建并注入 commonModulesCode
+  injectCommonModulesCode(config, cmpTypes, { excludeModel });
+}
+
 module.exports = {
   neoInit,
   neoInitByCopy,
@@ -63,208 +181,50 @@ module.exports = {
     }
     // 将 linkDebug 设置给 dev
     curConfig.dev = Object.assign(curConfig.dev, curConfig.linkDebug);
-
     delete curConfig.linkDebug;
 
     delete curConfig.dev.ignoreNodeModules; // 需要注入依赖
     curConfig.webpack.ignoreNodeModules = false;
 
-    const curEntry = curConfig.dev.entry;
-    let curCmpTypes = [];
-
-    if (!curEntry || Object.keys(curEntry).length === 0) {
-      // 如果未配置 entry，则自动生成 entry
-      let entries = {};
-      if (curConfig.dev.disableAutoRegister) {
-        // disableAutoRegister 为 true 时，仅自动生成入口文件（不自动注册）
-        const { linkDebugEntries, cmpTypes } = getEntries(curConfig.componentsDir);
-        entries = linkDebugEntries;
-        curCmpTypes = cmpTypes;
-      } else {
-        // 自动生成入口文件（并自动创建对应的注册文件）
-        const { linkDebugEntries, cmpTypes } = getEntriesWithAutoRegister(curConfig.componentsDir);
-        entries = linkDebugEntries;
-        curCmpTypes = cmpTypes;
-      }
-
-      // 注入 webpack/entry
-      if (entries && Object.keys(entries).length > 0) {
-        curConfig.dev.entry = entries;
-        console.info('已自动生成 entry 入口配置：', entries);
-      } else {
-        console.error(
-          `未识别到自定义组件，请检查 ${
-            curConfig.componentsDir || './src/components'
-          } 目录下是否存在自定义组件。`
-        );
-        process.exit(1);
-      }
-    }
-
-    /*
-    // 说明：自定义组件和平台模块联邦使用异常，所以暂时注释掉
-    // 添加模块联邦插件
-    if (curConfig.dev.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({ verbose: true }));
-    } else {
-      curConfig.webpack.plugins = [new AddNeoRequirePlugin({ verbose: true })];
-    }
-
-    // 添加 内置 Neo 的 externals 配置
-    const neoExternals = getExternalsByNeoCommonModules(cmpNeoExternals);
-    if (curConfig.dev.externals && _.isPlainObject(curConfig.dev.externals)) {
-      curConfig.dev.externals = Object.assign(curConfig.dev.externals, neoExternals);
-    } else {
-      curConfig.dev.externals = neoExternals;
-    }
-
-    // 写入自定义组件的共享模块和远程模块相关信息
-    const commonModulesFilePath = createCommonModulesCode(neoCommonModule, curCmpTypes);
+    // 生成并设置 entry 配置
+    const curCmpTypes = setupEntries(curConfig.dev, {
+      entryType: 'linkDebug',
+      forceGetCmpTypes: true // linkDebug 需要 cmpTypes 来生成 commonModulesCode
+    });
 
-    // 所有入口文件添加 commonModulesFile
-    if (commonModulesFilePath && curConfig.dev.entry) {
-      Object.keys(curConfig.dev.entry).forEach((name) => {
-        curConfig.dev.entry[name] = [commonModulesFilePath].concat(curConfig.dev.entry[name]);
-      });
-    }
+    // 配置 webpack 插件、externals 和 commonModulesCode
+    configureNeoBuild(curConfig.dev, curCmpTypes, {
+      verbose: true,
+      excludeModel: false // linkDebug 不排除 Model
+    });
 
     akfun.dev(curConfig, consoleTag);
   },
   build: () => akfun.build('build', curConfig, consoleTag), // 构建脚本：生产环境
   build2lib: () => {
-    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);
-        entries = widgetEntries;
-        curCmpTypes = cmpTypes;
-      } else {
-        // 自动生成入口文件（并自动创建对应的注册文件）
-        const { widgetEntries, cmpTypes } = getEntriesWithAutoRegister(curConfig.componentsDir);
-        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.build2lib.enableMF) {
-      // 添加模块联邦插件
-      curConfig.webpack.plugins.push(...MFPlugins);
-    }
-    */
+    // 生成并设置 entry 配置
+    setupEntries(curConfig.build2lib, {
+      entryType: 'widget'
+    });
 
     akfun.build('lib', curConfig, consoleTag);
   }, // 构建脚本：生产环境
   publish2oss: (cmpType) => {
     // 将 publish2oss 相关配置设置给 build2lib
     const publish2ossConfig = curConfig.publish2oss;
-    curConfig.build2lib = Object.assign(curConfig.build2lib, publish2ossConfig);
-
-    const curEntry = curConfig.build2lib.entry;
-    let curCmpTypes = [];
+    curConfig.build2lib = prepareBuild2LibConfig(publish2ossConfig);
 
-    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.publish2oss.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({ verbose: true }));
-    } else {
-      curConfig.webpack.plugins = [new AddNeoRequirePlugin({ verbose: true })];
-    }
-
-    // 添加 内置 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);
+    // 生成并设置 entry 配置
+    const curCmpTypes = setupEntries(curConfig.build2lib, {
+      entryType: 'widget',
+      cmpType
+    });
 
-    // 所有入口文件添加 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]
-          );
-        }
-      });
-    }
+    // 配置 webpack 插件、externals 和 commonModulesCode
+    configureNeoBuild(curConfig.build2lib, curCmpTypes, {
+      verbose: true,
+      excludeModel: true // publish2oss 排除 Model 结尾的文件
+    });
 
     akfun.build('lib', curConfig, consoleTag, () => {
       // 构建完成后，执行 publish2oss
@@ -277,91 +237,31 @@ module.exports = {
   },
   // 发布组件到 NeoCRM 平台
   pushCmp: (cmpType) => {
+    const { neoConfig, pushCmp: _pushCmpConfig } = curConfig;
+    const pushCmpConfig = Object.assign({}, _pushCmpConfig, neoConfig);
     // 将 pushCmp 相关配置设置给 build2lib
-    const pushCmpConfig = curConfig.pushCmp;
-    curConfig.build2lib = Object.assign(curConfig.build2lib, pushCmpConfig);
-
-    const curEntry = curConfig.build2lib.entry;
-    let curCmpTypes = [];
+    curConfig.build2lib = prepareBuild2LibConfig(pushCmpConfig);
 
-    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);
+    // 生成并设置 entry 配置
+    const curCmpTypes = setupEntries(curConfig.build2lib, {
+      entryType: 'widget',
+      cmpType
+    });
 
-    // 所有入口文件添加 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]
-          );
-        }
-      });
-    }
+    // 配置 webpack 插件、externals 和 commonModulesCode
+    configureNeoBuild(curConfig.build2lib, curCmpTypes, {
+      verbose: false,
+      excludeModel: true // pushCmp 排除 Model 结尾的文件
+    });
 
     akfun.build('lib', curConfig, consoleTag, () => {
       // 构建完成后，执行 pushCmp
       pushCmp(pushCmpConfig, cmpType);
     });
   },
+  // 从 NeoCRM 平台拉取组件
+  pullCmp: (cmpType, neoService) => {
+    pullCmp(cmpType, curConfig.neoConfig, neoService);
+  },
   build2esm: (fileName) => akfun.build2esm(fileName, curConfig, consoleTag) // 构建esm输出模块
 };

package/src/module/neoInit.js

@@ -1,4 +1,5 @@
 const { gitClone } = require('akfun');
+const path = require('path');
 const { consoleTag } = require('../utils/neoParams'); // 输出标记
 const { replaceInPackage } = require('../utils/replaceInPackage');
 const { resetPackageVersion } = require('../utils/resetPackageVersion');

package/src/neo/NeoUMDContent.js

@@ -1,6 +1,7 @@
 /**
  * 内置 UMD 模块，用于在 Node cli 端加载自定义组件模型
  * 特别说明：这个文件内容会通过 AddNeoRequirePlugin 插入的构建代码中。
+ * 暂未使用，保留备用。
  */
 (function (root, factory) {
   // AMD 环境检测
@@ -15,15 +16,15 @@
   else {
     root.NeoCustomCmpModel = factory();
   }
-}(typeof self !== 'undefined' ? self : this, function () {
+})(typeof self !== 'undefined' ? self : this, function () {
   'use strict';
-  
+
   const getCustomModels = (cmpType) => {
     // 自定义组件模型列表
     const NEOEditorCustomModels = window.NEOEditorCustomModels || {};
     return NEOEditorCustomModels[cmpType] || {};
-  }
-  
+  };
+
   // 导出模块
   return getCustomModels;
-}));
+});