neo-cmp-cli 1.5.0-beta.3 → 1.5.0-beta.6

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');
@@ -151,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]',
     '预览指定自定义组件（仅预览组件本身内容）',
@@ -158,26 +234,36 @@ 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: '请输入要预览的自定义组件名称:',
+            type: 'list',
+            message: '请选择要预览的自定义组件:',
+            choices: cmpTypeChoices
           }
         ];
         inquirer.prompt(questions).then((ans) => {
           if (!ans.cmpType) {
-            console.error('自定义组件名称不能为空。');
+            console.error('未选择要预览的自定义组件。');
             process.exit(1);
           }
           mainAction.previewCmp(ans.cmpType);
@@ -244,46 +330,83 @@ 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(
-    'publishCmp [options]',
+    'pushCmp [options]',
     '发布组件到 NeoCRM 平台',
     (yargs) => {
       yargs
         .reset()
-        .usage(titleTip('Usage') + ': $0 publishCmp [options]')
-        .option('cmpType', {
-          alias: 't',
+        .usage(titleTip('Usage') + ': $0 pushCmp [options]')
+        .option('name', {
+          alias: 'n',
           describe: '自定义组件名称'
         })
         .alias('h', 'help');
     },
     (argv) => {
-      if (argv.cmpType) {
-        mainAction.publishCmp(argv.cmpType); // 构建并发布组件到 NeoCRM
+      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: 'input',
-            message: '请输入要发布的自定义组件名称:'
+            type: 'list',
+            message: '请选择要发布的自定义组件:',
+            choices: cmpTypeChoices
           }
         ];
         inquirer.prompt(questions).then((ans) => {
           if (!ans.cmpType) {
-            console.error('自定义组件名称不能为空。');
+            console.error('未选择要发布的自定义组件。');
             process.exit(1);
           }
-          mainAction.publishCmp(ans.cmpType);
+          mainAction.pushCmp(ans.cmpType);
         });
       }
     }

package/src/module/main.js

@@ -7,14 +7,16 @@ const neoConfigInit = require('../utils/neoConfigInit.js');
 const { consoleTag } = require('../utils/neoParams');
 const curConfig = require('../config/index'); // 获取当前项目根目录下的配置文件
 const publish2oss = require('../oss/publish2oss');
-const publishCmp = require('../cmpUtils/publishCmp');
-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 createCmpProjectByTemplate = require('../projectUtils/createCmpProjectByTemplate');
+const createCmpByTemplate = require('../cmpUtils/createCmpByTemplate');
 
 const getValue = (originValue, defaultValue) => {
   return originValue !== undefined ? originValue : defaultValue;
@@ -29,6 +31,8 @@ module.exports = {
   neoInitByCopy,
   inspect,
   neoConfigInit,
+  createCmpProjectByTemplate,
+  createCmpByTemplate,
   dev: () => {
     if (!curConfig.dev) {
       console.error('未找到 dev 相关配置。');
@@ -272,10 +276,10 @@ module.exports = {
     });
   },
   // 发布组件到 NeoCRM 平台
-  publishCmp: (cmpType) => {
-    // 将 publishCmp 相关配置设置给 build2lib
-    const publishCmpConfig = curConfig.publishCmp;
-    curConfig.build2lib = Object.assign(curConfig.build2lib, publishCmpConfig);
+  pushCmp: (cmpType) => {
+    // 将 pushCmp 相关配置设置给 build2lib
+    const pushCmpConfig = curConfig.pushCmp;
+    curConfig.build2lib = Object.assign(curConfig.build2lib, pushCmpConfig);
 
     const curEntry = curConfig.build2lib.entry;
     let curCmpTypes = [];
@@ -315,7 +319,7 @@ module.exports = {
     /*
     // 说明：自定义组件和平台模块联邦使用异常，所以暂时注释掉
     // 添加模块联邦插件
-    if (curConfig.publishCmp.enableMF) {
+    if (curConfig.pushCmp.enableMF) {
       curConfig.webpack.plugins.push(...MFPlugins);
     }
     */
@@ -355,8 +359,8 @@ module.exports = {
     }
 
     akfun.build('lib', curConfig, consoleTag, () => {
-      // 构建完成后，执行 publishCmp
-      publishCmp(publishCmpConfig, cmpType);
+      // 构建完成后，执行 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/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
 };

package/src/neo/neoService.js

@@ -3,7 +3,7 @@ const FormData = require('form-data');
 const fs = require('fs');
 const path = require('path');
 const _ = require('lodash');
-const updatePublishLog = require('../cmpUtils/updatePublishLog');
+const updatePublishLog = require('../projectUtils/updatePublishLog');
 
 // NeoCRM 平台默认 API 配置
 const NeoCrmAPI = {
@@ -23,32 +23,32 @@ class NeoService {
    * @param {object} config 配置信息
    * @param {string} config.neoBaseURL Neo 平台根地址
    * @param {string} config.tokenAPI Token 获取接口地址
-   * @param {object} config.authorization 授权信息
-   * @param {string} config.authorization.client_id 客户端 ID
-   * @param {string} config.authorization.client_secret 客户端密钥
-   * @param {string} config.authorization.username 用户名
-   * @param {string} config.authorization.password 密码
+   * @param {object} config.authConfig 授权信息
+   * @param {string} config.authConfig.client_id 客户端 ID
+   * @param {string} config.authConfig.client_secret 客户端密钥
+   * @param {string} config.authConfig.username 用户名
+   * @param {string} config.authConfig.password 密码
    */
   constructor(config = {}) {
-    const { assetsRoot, neoBaseURL, tokenAPI, authorization } = config;
-    if (!authorization) {
-      throw new Error('authorization 不能为空');
+    const { assetsRoot, neoBaseURL, tokenAPI, authConfig } = config;
+    if (!authConfig) {
+      throw new Error('authConfig 不能为空');
     }
     if (
-      !authorization.client_id ||
-      !authorization.client_secret ||
-      !authorization.username ||
-      !authorization.password
+      !authConfig.client_id ||
+      !authConfig.client_secret ||
+      !authConfig.username ||
+      !authConfig.password
     ) {
       throw new Error(
-        'authorization 配置不完整，需要包含 client_id、client_secret、username、password'
+        'authConfig 配置不完整，需要包含 client_id、client_secret、username、password'
       );
     }
 
     this.assetsRoot = assetsRoot;
     this.neoBaseURL = neoBaseURL || NeoCrmAPI.neoBaseURL;
     this.tokenAPI = tokenAPI || NeoCrmAPI.tokenAPI;
-    this.authorization = authorization;
+    this.authConfig = authConfig;
 
     // Token 缓存
     this.tokenCache = {
@@ -106,10 +106,10 @@ class NeoService {
     // 构建表单数据格式的请求参数
     const formData = new URLSearchParams();
     formData.append('grant_type', 'password');
-    formData.append('client_id', this.authorization.client_id);
-    formData.append('client_secret', this.authorization.client_secret);
-    formData.append('username', this.authorization.username);
-    formData.append('password', this.authorization.password);
+    formData.append('client_id', this.authConfig.client_id);
+    formData.append('client_secret', this.authConfig.client_secret);
+    formData.append('username', this.authConfig.username);
+    formData.append('password', this.authConfig.password);
 
     const tokenUrl = this.buildFullUrl(this.tokenAPI);
 
@@ -123,7 +123,7 @@ class NeoService {
       const { access_token, expires_in } = response.data || {};
 
       if (!access_token) {
-        console.error('获取 token 失败：响应中未包含 access_token', response.data);
+        console.error('\n获取 token 失败：响应中未包含 access_token', response.data);
         process.exit(1);
       }
 
@@ -135,7 +135,7 @@ class NeoService {
       };
       return access_token;
     } catch (error) {
-      console.error('获取 token 失败:', error.message);
+      console.error('\n获取 token 失败:', error.message);
       console.error('\ntoken 授权地址:', tokenUrl);
       console.error('\ntoken 请求参数:', formData);
       if (error.response) {
@@ -296,11 +296,11 @@ class NeoService {
       } else if (resultData && typeof resultData === 'object' && resultData.url) {
         fileUrl = resultData.url;
       }
-      console.info(`文件上传成功: ${fileName} -> ${fileUrl}`);
+      console.info(`\n文件上传成功: ${fileName} -> ${fileUrl}`);
       return fileUrl;
     } catch (error) {
-      console.error(`上传文件失败: ${error.message}`);
-      console.error(`文件路径: ${filePath}`);
+      console.error(`\n上传文件失败: ${error.message}，`);
+      console.error(`文件路径: ${filePath}。\n`);
       
       // 输出详细的错误信息
       if (error.response) {
@@ -412,7 +412,6 @@ class NeoService {
 
     try {
       const fullUpdateAPI = this.saveAPI();
-      console.info('更新组件 API 地址:', fullUpdateAPI);
       const response = await axios.post(fullUpdateAPI, componentData, {
         headers: {
           Authorization: `Bearer ${token}`,
@@ -420,17 +419,19 @@ class NeoService {
           'Content-Type': 'application/json'
         }
       });
+      const {code, message} = response.data || {};
 
-      if (response.data && response.data.code && response.data.code !== 200) {
+      if (code && code !== 200) {
         throw new Error(`更新组件失败: ${response.data.message || '未知错误'}`);
       }
+      
 
-      console.info('组件更新成功:', response.data);
-      return response.data;
+      console.info(message ? `组件更新成功: ${message}。` : '组件更新成功。');
     } catch (error) {
-      console.error('更新组件失败:', error.message);
-      if (error.response) {
-        console.error('响应数据:', error.response.data);
+      if (error.message) {
+        console.error('更新组件失败:', error.message);
+      } else {
+        console.error('响应数据:', error);
       }
       process.exit(1);
     }

package/src/oss/publish2oss.js

@@ -4,7 +4,7 @@ const path = require('path');
 const _ = require('lodash');
 const { catchCurPackageJson } = require('../utils/pathUtils');
 const getConfigObj = require('../utils/getConfigObj');
-const updatePublishLog = require('../cmpUtils/updatePublishLog');
+const updatePublishLog = require('../projectUtils/updatePublishLog');
 
 // 获取当前项目的package文件
 const currentPackageJsonDir = catchCurPackageJson();

package/src/plugins/AddNeoRequirePlugin.js

@@ -1,4 +1,6 @@
 const { ConcatSource } = require('webpack-sources');
+const fs = require('fs');
+const path = require('path');
 /**
  * 注入 neoRequire 函数
  * 备注：用于实现和 Neo 平台共享依赖
@@ -162,9 +164,9 @@ class AddNeoRequirePlugin {
 })(function(require) {
                 `;
 
-    const NeoUMDContent = fs.readFileSync(path.join(__dirname, '../neo/NeoUMDContent.js'), 'utf8');
-
-    const Footer = `}); \n${NeoUMDContent}`;
+    // const NeoUMDContent = fs.readFileSync(path.join(__dirname, '../neo/NeoUMDContent.js'), 'utf8');
+    // const Footer = `}); \n${NeoUMDContent}`;
+    const Footer = `});`;
 
     // 创建新的资源
     const newSource = new ConcatSource(Header, content, Footer);

package/src/projectUtils/createCmpProjectByTemplate.js

@@ -0,0 +1,49 @@
+const fs = require('fs-extra');
+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 cmpTemplateList = {
+  'react-ts': {
+    projectName: 'empty-custom-cmp-template',
+    dir: path.resolve(__dirname, '../template/empty-custom-cmp-template')
+  }
+};
+
+/**
+ * 通过拷贝模板创建自定义组件
+ * @param {*} projectName 自定义组件项目名称
+ * @param {*} type 自定义组件类型
+ */
+module.exports = function (projectName, type = 'react-ts') {
+  const finalProjectPath = path.resolve(process.cwd(), projectName);
+
+  if (fs.existsSync(finalProjectPath)) {
+    console.error(`${consoleTag}创建自定义组件失败，当前已存在（${projectName}）项目，请勿创建重名项目。`);
+    process.exit(1);
+  }
+
+  const curCmpTemplate = cmpTemplateList[type];
+  if (!curCmpTemplate) {
+    console.error(`${consoleTag}创建自定义组件失败，当前不支持${type}类型。`);
+    process.exit(1);
+  }
+
+  const currentTemplateDir = curCmpTemplate.dir;
+  const finalProjectName = projectName || 'neoCustomCmp';
+
+  fs.copy(currentTemplateDir, finalProjectPath)
+    .then(() => {
+      replaceInPackage(finalProjectPath, curCmpTemplate.projectName, finalProjectName);
+      replaceInPackage(finalProjectPath, 'wibetter', 'xxx');
+      replaceInPackage(finalProjectPath, 'neo自定义组件模板', 'neo自定义组件');
+      resetPackageVersion(finalProjectPath);
+
+      console.log(`${consoleTag}已创建自定义组件（${finalProjectName}）!`);
+      // 自动切换到项目根目录
+      autoEntryRootDir(finalProjectPath);
+    })
+    .catch((err) => console.error(`${consoleTag}自定义组件模板下载失败：`, err));
+};

package/src/{cmpUtils → projectUtils}/getEntriesWithAutoRegister.js

@@ -2,8 +2,8 @@ const fs = require('fs');
 const path = require('path');
 const _ = require('lodash');
 const { resolveToCurrentRoot } = require('../utils/pathUtils');
-const getCmpRegister = require('./getCmpRegister');
-const getCmpModelRegister = require('./getCmpModelRegister');
+const getCmpRegisterCode = require('./getCmpRegisterCode');
+const getCmpModelRegisterCode = require('./getCmpModelRegisterCode');
 /**
  * 从指定目录获取组件入口文件，并自动创建对应的注册文件
  * @param {*} defaultComponentsDir 默认组件目录
@@ -68,7 +68,7 @@ module.exports = (defaultComponentsDir = './src/components', cmpType) => {
           .forEach((filePath) => {
             if (filePath.match(/index\.[tj]sx?$/)) {
               // 自动创建对应的注册文件
-              const registerContent = getCmpRegister(componentsBaseDir, curCmpName);
+              const registerContent = getCmpRegisterCode(componentsBaseDir, curCmpName);
               const registerDir = `${cmpTempDir}/register.js`;
 
               // 写入注册文件
@@ -78,7 +78,7 @@ module.exports = (defaultComponentsDir = './src/components', cmpType) => {
               linkDebugEntries.index.push(registerDir);
             } else if (filePath.match(/model\.[tj]sx?$/)) {
               // 自动创建对应的模型注册文件
-              const modelRegisterContent = getCmpModelRegister(componentsBaseDir, curCmpName);
+              const modelRegisterContent = getCmpModelRegisterCode(componentsBaseDir, curCmpName);
               const modelRegisterDir = `${cmpTempDir}/model.js`;
 
               // 写入模型注册文件

package/src/template/antd-custom-cmp-template/README.md

@@ -37,10 +37,10 @@ $ npm run preview
 $ npm run linkDebug
 ```
 
-4. **发布到对象存储服务中**
+4. **发布到 NeoCRM 平台**
 > 需要确保 package.json 中的 name 值唯一，version 值不重复。
 ```bash
-$ npm run publish2oss
+$ npm run pushCmp
 ```
 
 ### 配置项说明（neo-cmp-cli）