neo-cmp-cli 1.7.12 → 1.7.13

package/package.json

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

package/src/module/main.js

@@ -10,98 +10,39 @@ const publish2oss = require('../oss/publish2oss');
 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('../utils/cmpUtils/createCommonModulesCode');
 const createCmpByTemplate = require('../utils/cmpUtils/createCmpByTemplate');
 const createCmpProjectByTemplate = require('../utils/projectUtils/createCmpProjectByTemplate');
 const pullCmp = require('../utils/cmpUtils/pullCmp');
 const deleteCmp = require('../utils/cmpUtils/deleteCmp');
 const openProject = require('../utils/projectUtils/openProject');
+const { configureNeoBuild } = require('../utils/configureNeoBuild');
 const { errorLog, successLog } = require('../utils/common');
 
 const getValue = (originValue, defaultValue) => {
   return originValue !== undefined ? originValue : defaultValue;
 };
 
-const neoCommonModule = curConfig.neoCommonModule || {};
-// 自定义组件 需要剔除的依赖模块
-const cmpNeoExternals = neoCommonModule.externals || [];
-
-/**
- * 添加 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 externals = getExternalsByNeoCommonModules(cmpNeoExternals);
-  if (externalsConfig && _.isPlainObject(externalsConfig)) {
-    config.externals = Object.assign(externalsConfig, externals);
-  } else {
-    config.externals = externals;
-  }
-}
-
-/**
- * 创建并注入 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;
+  const { entryType, cmpType } = options;
 
   let cmpTypes = [];
+  let defaultExports = {};
   try {
-    const { entries, cmpTypes: generatedCmpTypes } = generateEntries({
+    const { entries, cmpTypes: generatedCmpTypes, defaultExports: generatedDefaultExports } = generateEntries({
       configEntry: config.entry,
       disableAutoRegister: config.disableAutoRegister,
       componentsDir: curConfig.componentsDir,
       entryType,
-      cmpType,
-      forceGetCmpTypes
+      cmpType
     });
 
     if (entries && Object.keys(entries).length > 0) {
@@ -109,12 +50,17 @@ function setupEntries(config, options) {
       cmpTypes = generatedCmpTypes;
       console.info('已自动生成 entry 入口配置：', entries);
     }
+
+    defaultExports = generatedDefaultExports;
   } catch (error) {
     errorLog(error.message);
     process.exit(1);
   }
 
-  return cmpTypes;
+  return {
+    cmpTypes,
+    defaultExports
+  };
 }
 
 /**
@@ -126,27 +72,6 @@ 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,
@@ -190,13 +115,14 @@ module.exports = {
     curConfig.webpack.ignoreNodeModules = false;
 
     // 生成并设置 entry 配置
-    const curCmpTypes = setupEntries(curConfig.dev, {
-      entryType: 'linkDebug',
-      forceGetCmpTypes: true // linkDebug 需要 cmpTypes 来生成 commonModulesCode
+    const {cmpTypes: curCmpTypes, defaultExports} = setupEntries(curConfig.dev, {
+      entryType: 'linkDebug'
     });
 
     // 配置 webpack 插件、externals 和 commonModulesCode
-    configureNeoBuild(curConfig.dev, curCmpTypes, {
+    configureNeoBuild(curConfig.dev, {
+      cmpTypes: curCmpTypes,
+      defaultExports,
       verbose: true,
       excludeModel: false // linkDebug 不排除 Model
     });
@@ -218,13 +144,15 @@ module.exports = {
     curConfig.build2lib = prepareBuild2LibConfig(publish2ossConfig);
 
     // 生成并设置 entry 配置
-    const curCmpTypes = setupEntries(curConfig.build2lib, {
+    const {cmpTypes: curCmpTypes, defaultExports} = setupEntries(curConfig.build2lib, {
       entryType: 'widget',
       cmpType
     });
 
     // 配置 webpack 插件、externals 和 commonModulesCode
-    configureNeoBuild(curConfig.build2lib, curCmpTypes, {
+    configureNeoBuild(curConfig.build2lib, {
+      cmpTypes: curCmpTypes,
+      defaultExports,
       verbose: true,
       excludeModel: true // publish2oss 排除 Model 结尾的文件
     });
@@ -246,13 +174,15 @@ module.exports = {
     curConfig.build2lib = prepareBuild2LibConfig(pushCmpConfig);
 
     // 生成并设置 entry 配置
-    const curCmpTypes = setupEntries(curConfig.build2lib, {
+    const {cmpTypes: curCmpTypes, defaultExports} = setupEntries(curConfig.build2lib, {
       entryType: 'widget',
       cmpType
     });
 
     // 配置 webpack 插件、externals 和 commonModulesCode
-    configureNeoBuild(curConfig.build2lib, curCmpTypes, {
+    configureNeoBuild(curConfig.build2lib, {
+      cmpTypes: curCmpTypes,
+      defaultExports,
       verbose: false,
       excludeModel: true // pushCmp 排除 Model 结尾的文件
     });

package/src/neo/neoRequire.js

@@ -50,7 +50,17 @@ const addNeoCommonModules = (modules) => {
       const curModule = modules[moduleId];
       const curCommonModule = window.__NeoCommonModules[moduleId];
       
+      /**
+       * 如果 Neo 共享出来的依赖模块已经存在，则合并到 window.__NeoCommonModules 中
+       * 目的：解决依赖加载顺序问题，确保存在依赖的组件无论其加载顺序如何都能正常运行。
+       * 
+       * 疑问1: 为什么 neoRequire 要返回一个 空的默认模块对象？
+       * 答：组件A 依赖 组件B 时，当 组件A 先加载（挂载对应的 asset 资源脚本）会报错，为了避免挂载时报错返回一个默认的空模块对象。
+       * 疑问2: 为什么不直接替换已有的模块，而是进行覆盖式合并（保持引用关联）？
+       * 答：为了避免依赖模块的引用关系被破坏，保持引用关联。确保动态注册进来的模块可以被提前挂载的组件所使用。
+       */
       if (curCommonModule && Object.keys(curCommonModule).length < 3) {
+        // 如果是默认模块对象，则覆盖式合并（保持引用关联）
         window.__NeoCommonModules[moduleId] = Object.assign(window.__NeoCommonModules[moduleId], curModule);
 
         // 处理模块中的特殊属性

package/src/utils/configureNeoBuild.js

@@ -0,0 +1,108 @@
+const AddNeoRequirePlugin = require('../plugins/AddNeoRequirePlugin');
+const createCommonModulesCode = require('../utils/cmpUtils/createCommonModulesCode');
+const { getExternalsByNeoCommonModules } = require('../neo/neoRequire');
+const curConfig = require('../config/index'); // 获取当前项目根目录下的配置文件
+
+// neo.config.js 中的添加的 Neo 共享依赖模块配置
+const neoCommonModule = curConfig.neoCommonModule || {};
+// 自定义组件 需要剔除的依赖模块
+const cmpNeoExternals = neoCommonModule.externals || [];
+
+// 组件目录
+const componentsDir = curConfig.componentsDir || './src/components';
+
+/**
+ * 添加 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 externals = getExternalsByNeoCommonModules(cmpNeoExternals);
+  if (externalsConfig && _.isPlainObject(externalsConfig)) {
+    config.externals = Object.assign(externalsConfig, externals);
+  } else {
+    config.externals = externals;
+  }
+}
+
+/**
+ * 创建并注入 commonModulesCode 到 entry
+ * @param {object} config 配置对象（dev 或 build2lib）
+ * @param {array} cmpTypes 组件类型列表
+ * @param {object} [options] 选项
+ * @param {boolean} [options.excludeModel] 是否排除 Model 结尾的 entry，默认为 false
+ */
+function injectCommonModulesCode(config, options = {}) {
+  const { cmpTypes, defaultExports, excludeModel = false } = options;
+
+  // 添加默认导出
+  if (defaultExports && _.isPlainObject(defaultExports)) {
+    if (neoCommonModule.exports && _.isPlainObject(neoCommonModule.exports)) {
+      neoCommonModule.exports = Object.assign(neoCommonModule.exports, defaultExports);
+    } else if (neoCommonModule.exports && _.isArray(neoCommonModule.exports)) {
+      // 先将数组格式改成对象格式
+      neoCommonModule.exports.forEach((item) => {
+        if (_.isString(item)) {
+          neoCommonModule.exports[item] = item;
+        }
+      });
+      neoCommonModule.exports = Object.assign(neoCommonModule.exports, defaultExports);
+    } else {
+      neoCommonModule.exports = defaultExports;
+    }
+  }
+
+  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]);
+      }
+    });
+  }
+}
+
+/**
+ * 配置 webpack 插件、externals 和 commonModulesCode（用于 linkDebug、publish2oss、pushCmp）
+ * @param {object} config 配置对象（dev 或 build2lib）
+ * @param {object} [options] 选项
+ * @param {array} [options.cmpTypes] 组件类型列表
+ * @param {object} [options.defaultExports] 默认导出
+ * @param {boolean} [options.verbose] 是否启用详细日志，默认为 false
+ * @param {boolean} [options.excludeModel] 是否排除 Model 结尾的 entry，默认为 false
+ */
+function configureNeoBuild(config, options = {}) {
+  const { cmpTypes, defaultExports, verbose = false, excludeModel = false } = options;
+
+  // 添加自定义 webpack 插件
+  addNeoRequirePlugin(curConfig.webpack, { verbose });
+
+  // 添加内置 Neo 的 externals 配置
+  addNeoExternals(config, config.externals);
+
+  // 创建并注入 commonModulesCode
+  injectCommonModulesCode(config, { cmpTypes, defaultExports, excludeModel });
+}
+
+module.exports = {
+  configureNeoBuild
+};

package/src/utils/generateEntries.js

@@ -9,19 +9,16 @@ const getEntriesWithAutoRegister = require('./projectUtils/getEntriesWithAutoReg
  * @param {string} options.componentsDir 组件目录路径
  * @param {string} options.entryType entry 类型：'widget' | 'linkDebug'，默认为 'widget'
  * @param {string} [options.cmpType] 可选的组件类型，如果指定则只生成该组件的 entry
- * @param {boolean} [options.forceGetCmpTypes] 即使 entry 已存在，也强制获取 cmpTypes，默认为 false
- * @returns {object} { entries: object, cmpTypes: array } 如果 configEntry 已存在且 forceGetCmpTypes 为 false，则返回 { entries: configEntry, cmpTypes: [] }
  */
 function generateEntries({
   configEntry,
   disableAutoRegister,
   componentsDir,
   entryType = 'widget',
-  cmpType,
-  forceGetCmpTypes = false
+  cmpType
 }) {
   // 如果已配置 entry 且不需要强制获取 cmpTypes，直接返回
-  if (configEntry && Object.keys(configEntry).length > 0 && !forceGetCmpTypes) {
+  if (configEntry && Object.keys(configEntry).length > 0) {
     return {
       entries: configEntry,
       cmpTypes: []
@@ -48,16 +45,8 @@ function generateEntries({
 
   const cmpTypes = entriesResult.cmpTypes || [];
 
-  // 如果 entry 已存在但需要获取 cmpTypes，使用已存在的 entry
-  if (configEntry && Object.keys(configEntry).length > 0 && forceGetCmpTypes) {
-    entries = configEntry;
-  }
-
   // 验证 entries 是否有效（仅在需要生成新 entry 时验证）
-  if (
-    (!configEntry || Object.keys(configEntry).length === 0) &&
-    (!entries || Object.keys(entries).length === 0)
-  ) {
+  if (!entries || Object.keys(entries).length === 0) {
     const defaultComponentsDir = componentsDir || './src/components';
     throw new Error(
       `未识别到自定义组件，请检查 ${defaultComponentsDir} 目录下是否存在自定义组件。`
@@ -66,7 +55,8 @@ function generateEntries({
 
   return {
     entries: entries || configEntry || {},
-    cmpTypes
+    cmpTypes,
+    defaultExports: entriesResult.defaultExports || {}
   };
 }
 

package/src/utils/projectUtils/getEntries.js

@@ -14,6 +14,7 @@ module.exports = (defaultComponentsDir = './src/components', cmpType) => {
     index: []
   };
   const cmpTypes = []; // 用于记录组件名称
+  const defaultExports = {}; // 用于记录默认导出
   const componentsBaseDir = resolveToCurrentRoot(defaultComponentsDir);
   if (!fs.existsSync(componentsBaseDir)) {
     console.error(`未找到组件目录，请检查 ${defaultComponentsDir} 目录是否存在`);
@@ -47,7 +48,7 @@ module.exports = (defaultComponentsDir = './src/components', cmpType) => {
         cmpTypes.push(curCmpName);
 
         fs.readdirSync(curCmpPath)
-          .filter((file) => file.match(/[register|model]\.[tj]sx?$/))
+          .filter((file) => file.match(/[index|register|model]\.(tsx?|jsx?|vue)$/))
           .map((file) => path.join(defaultComponentsDir, curCmpName, file))
           .forEach((filePath) => {
             const curPath = `./${filePath}`;
@@ -55,6 +56,9 @@ module.exports = (defaultComponentsDir = './src/components', cmpType) => {
               widgetEntries[cmpNameKey] = curPath;
             } else if (filePath.match(/model\.[tj]sx?$/)) {
               widgetEntries[`${cmpNameKey}Model`] = curPath;
+            } else if (filePath.match(/index\.(tsx?|jsx?|vue)$/)) {
+              // 组件内容文件
+              defaultExports[cmpNameKey] = path.resolve(filePath); // 记录默认导出
             }
             linkDebugEntries.index.push(curPath);
           });
@@ -70,6 +74,7 @@ module.exports = (defaultComponentsDir = './src/components', cmpType) => {
   return {
     widgetEntries,
     linkDebugEntries,
-    cmpTypes
+    cmpTypes,
+    defaultExports
   };
 };

package/src/utils/projectUtils/getEntriesWithAutoRegister.js

@@ -15,6 +15,7 @@ module.exports = (defaultComponentsDir = './src/components', cmpType) => {
     index: []
   };
   const cmpTypes = []; // 用于记录组件名称
+  const defaultExports = {}; // 用于记录默认导出
   const componentsBaseDir = resolveToCurrentRoot(defaultComponentsDir);
   if (!fs.existsSync(componentsBaseDir)) {
     console.error(`未找到组件目录，请检查 ${defaultComponentsDir} 目录是否存在`);
@@ -41,14 +42,12 @@ module.exports = (defaultComponentsDir = './src/components', cmpType) => {
 
     // 遍历所有目录
     widgetDirs.forEach((dir) => {
-      const filePath = path.join(componentsBaseDir, dir);
+      // 当前自定义组件目录
+      const widgetPath = path.join(componentsBaseDir, dir);
       // 获取文件状态
       const stat = fs.statSync(filePath);
       // 如果文件是目录，则递归处理子目录
       if (stat.isDirectory() && !dir.startsWith('.') && dir !== 'node_modules') {
-        // 当前自定义组件目录
-        const widgetPath = path.join(componentsBaseDir, dir);
-
         // 当前自定义组件名称
         const curCmpName = dir; // _.camelCase(dir);
         const cmpNameKey = _.camelCase(curCmpName);
@@ -67,6 +66,9 @@ module.exports = (defaultComponentsDir = './src/components', cmpType) => {
           .map((file) => path.join(defaultComponentsDir, curCmpName, file))
           .forEach((filePath) => {
             if (filePath.match(/index\.(tsx?|jsx?|vue)$/)) {
+              // 记录默认导出
+              defaultExports[cmpNameKey] = path.resolve(filePath);
+
               // 自动创建对应的注册文件
               const registerContent = getCmpRegisterCode(componentsBaseDir, curCmpName);
               const registerDir = `${cmpTempDir}/register.js`;
@@ -100,6 +102,7 @@ module.exports = (defaultComponentsDir = './src/components', cmpType) => {
   return {
     widgetEntries,
     linkDebugEntries,
-    cmpTypes
+    cmpTypes,
+    defaultExports
   };
 };

package/test/demo.js

@@ -1,6 +1,6 @@
-const {neoInit, neoConfigInit, inspect, preview, debug, build2lib, build2esm, neoInitByCopy, previewCmp, } = require('../src/module/main');
-const getEntries = require('../src/projectUtils/getEntries');
-const getEntriesWithAutoRegister = require('../src/projectUtils/getEntriesWithAutoRegister');
+const {neoInit, neoConfigInit, inspect, preview, debug, build2lib, build2esm, neoInitByCopy, previewCmp } = require('../src/module/main');
+const getEntries = require('../src/utils/projectUtils/getEntries');
+const getEntriesWithAutoRegister = require('../src/utils/projectUtils/getEntriesWithAutoRegister');
 // inspect('dev');
 // neoInitByCopy('react-ts', 'test123');
 

package/test/deprecate-versions.js

@@ -1,7 +1,7 @@
 const { execSync } = require('child_process');
 
 // 所有需要废弃的版本（1.6.2 之前的所有版本）
-const versionsToDeprecate = ["1.7.5", "1.7.5-beta.1", "1.7.5-beta.2", "1.7.6", "1.7.7", "1.7.8", "1.7.9", "1.7.10"];
+const versionsToDeprecate = ["1.7.10", "1.7.11"];
 
 const packageName = 'neo-cmp-cli';
 const deprecateMessage = '此版本为开发中版本（存在 bug），请升级到最新版本。';