neo-cmp-cli 1.7.5 → 1.7.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "neo-cmp-cli",
-  "version": "1.7.5",
+  "version": "1.7.6",
   "description": "前端脚手架：自定义组件开发工具，支持react 和 vue2.0技术栈。",
   "keywords": [
     "neo-cli",
@@ -43,18 +43,20 @@
     "adm-zip": "^0.5.10",
     "akfun": "^5.1.12",
     "axios": "^0.27.2",
+    "babel-plugin-import": "^1.13.8",
     "chalk": "^4.0.0",
     "deepmerge": "^4.2.2",
+    "external-remotes-plugin": "^1.0.0",
     "figlet": "^1.2.0",
     "form-data": "^4.0.0",
     "fs-extra": "^10.1.0",
     "inquirer": "^7.3.3",
+    "lodash": "^4.17.21",
+    "open": "^8.4.2",
     "ora": "^4.0.4",
+    "portfinder": "^1.0.38",
     "webpack-sources": "^3.2.3",
-    "yargs": "^12.0.2",
-    "lodash": "^4.17.21",
-    "external-remotes-plugin": "^1.0.0",
-    "babel-plugin-import": "^1.13.8"
+    "yargs": "^12.0.2"
   },
   "devDependencies": {
     "@commitlint/cli": "^8.3.5",

package/src/config/auth.config.js

@@ -0,0 +1,25 @@
+const curConfig = require('../config/index'); // 获取当前项目根目录下的配置文件
+
+const neoConfig = curConfig.neoConfig || {};
+const authConfig = neoConfig.auth || {};
+
+// NeoCRM 跨 Pod 授权配置
+module.exports = {
+  loginURL: neoConfig.loginURL || 'https://login-cd.xiaoshouyi.com/auc/oauth2/auth', // 登录 URL，从创建连接器的客户端信息中获取（Login_Url）
+  tokenAPI: neoConfig.tokenAPI || 'https://login-cd.xiaoshouyi.com/auc/oauth2/token', // Token 获取接口地址（默认：https://login.xiaoshouyi.com/auc/oauth2/token）
+  redirectUri: neoConfig.redirectUri || 'http://localhost:1028', // 固定端口号，用于接收授权码
+  // 重定向 URI，动态生成
+  getRedirectURI: (port) => {
+    return `http://localhost:${port}`;
+  },
+  // 获取 授权码 相关配置
+  response_type: 'code', // 认证类型；此参数值必须为 code
+  client_id: authConfig.client_id || '04c8b45c4dbe36426a660bf70d3fe3e7', // 客户端 ID，跨 Pod 级链接器【内置】
+  scope: 'all', // 固定值：all
+  oauthType: 'standard', // 固定值：standard
+  access_type: 'offline', // 此参数值为 online 时，不产生 refresh_token ；此参数值为 offline 时，返回refresh_token
+
+  // 获取 令牌 相关配置
+  client_secret: authConfig.client_secret || '370817d1336a3737f95c671eea39a23b', // 客户端秘钥，跨 Pod 级链接器【内置】
+  grant_type: 'authorization_code' // 授权类型；此参数值必须为 authorization_code
+};

package/src/config/default.config.js

@@ -133,6 +133,31 @@ const defaultNEOConfig = {
     },
     assetsRoot: resolve('dist') // 上传指定目录下的脚本文件
   },
+  // 授权码授权模式下的 NeoCRM 平台配置
+  neoConfig: {
+    authType: 'oauth2', // 授权类型，可选值：oauth2（默认）、password
+    neoBaseURL: 'https://crm-cd.xiaoshouyi.com', // 平台根地址（默认：https://crm.xiaoshouyi.com）
+    //  当 authType 为 oauth2 时，loginURL 配置项必填
+    loginURL: 'https://login-cd.xiaoshouyi.com/auc/oauth2/auth', // 登录授权 URL（默认：https://login.xiaoshouyi.com/auc/oauth2/auth）
+    tokenAPI: 'https://login-cd.xiaoshouyi.com/auc/oauth2/token' // Token 获取接口地址（默认：https://login.xiaoshouyi.com/auc/oauth2/token）
+  },
+  /*
+  // 密码授权模式下的 NeoCRM 平台配置
+  neoConfig: {
+    authType: 'password', // 授权类型，可选值：oauth2（默认）、password
+    neoBaseURL: 'https://crm-cd.xiaoshouyi.com', // 平台根地址（默认：https://crm.xiaoshouyi.com）
+    tokenAPI: 'https://login-cd.xiaoshouyi.com/auc/oauth2/token', // Token 获取接口地址（默认：https://login.xiaoshouyi.com/auc/oauth2/token）
+    // 当 authType 为 password 时，auth 配置项必填
+    auth: {
+      client_id: auth.client_id || 'xx', // 客户端 ID，从创建连接器的客户端信息中获取（Client_Id）
+      client_secret: auth.client_secret || 'xxx', // 客户端秘钥，从创建连接器的客户端信息中获取（Client_Secret）
+      username: auth.username || 'xx', // 用户在销售易系统中的用户名
+      // password 为 用户在销售易系统中的账号密码加上 8 位安全令牌。
+      // 例如，用户密码为 123456，安全令牌为 ABCDEFGH，则 password 的值应为 123456ABCDEFGH。
+      password: auth.password || 'xx xx', // 用户账户密码 + 8 位安全令牌
+    },
+  },
+  */
   pushCmp: {
     output: {
       filename: '[name].js',

package/src/initData/neo.config.js

@@ -97,22 +97,31 @@ module.exports = {
     }
     */
   },
-  // NeoCRM 平台配置
+  // 授权码授权模式下的 NeoCRM 平台配置
   neoConfig: {
+    authType: 'oauth2', // 授权类型，可选值：oauth2（默认）、password
+    neoBaseURL: 'https://crm-cd.xiaoshouyi.com', // 平台根地址（默认：https://crm.xiaoshouyi.com）
+    //  当 authType 为 oauth2 时，loginURL 配置项必填
+    loginURL: 'https://login-cd.xiaoshouyi.com/auc/oauth2/auth', // 登录授权 URL（默认：https://login.xiaoshouyi.com/auc/oauth2/auth）
+    tokenAPI: 'https://login-cd.xiaoshouyi.com/auc/oauth2/token' // Token 获取接口地址（默认：https://login.xiaoshouyi.com/auc/oauth2/token）
+  },
+  /*
+  // 密码授权模式下的 NeoCRM 平台配置
+  neoConfig: {
+    authType: 'password', // 授权类型，可选值：oauth2（默认）、password
     neoBaseURL: 'https://crm-cd.xiaoshouyi.com', // 平台根地址（默认：https://crm.xiaoshouyi.com）
     tokenAPI: 'https://login-cd.xiaoshouyi.com/auc/oauth2/token', // Token 获取接口地址（默认：https://login.xiaoshouyi.com/auc/oauth2/token）
-    // NeoCRM 授权配置
+    // 当 authType 为 password 时，auth 配置项必填
     auth: {
-      client_id: 'xx', // 客户端 ID，从创建连接器的客户端信息中获取（Client_Id）
-      client_secret: 'xxx', // 客户端秘钥，从创建连接器的客户端信息中获取（Client_Secret）
-      username: 'xx', // 用户在销售易系统中的用户名
-      /**
-       * password 为 用户在销售易系统中的账号密码加上 8 位安全令牌。
-       * 例如，用户密码为 123456，安全令牌为 ABCDEFGH，则 password 的值应为 123456ABCDEFGH。
-       */
-      password: 'xx xx' // 用户账户密码 + 8 位安全令牌
-    }
+      client_id: auth.client_id || 'xx', // 客户端 ID，从创建连接器的客户端信息中获取（Client_Id）
+      client_secret: auth.client_secret || 'xxx', // 客户端秘钥，从创建连接器的客户端信息中获取（Client_Secret）
+      username: auth.username || 'xx', // 用户在销售易系统中的用户名
+      // password 为 用户在销售易系统中的账号密码加上 8 位安全令牌。
+      // 例如，用户密码为 123456，安全令牌为 ABCDEFGH，则 password 的值应为 123456ABCDEFGH。
+      password: auth.password || 'xx xx', // 用户账户密码 + 8 位安全令牌
+    },
   },
+  */
   pushCmp: {
     // 用于构建并发布至 NeoCRM 的相关配置
     /*

package/src/module/index.js

@@ -11,9 +11,11 @@ const { validateProjectName } = require('../utils/projectNameValidator.js');
 const mainAction = require('./main.js'); // 入口文件
 const getCmpTypeByDir = require('../utils/cmpUtils/getCmpTypeByDir.js');
 const NeoService = require('../neo/neoService.js');
+const NeoLoginService = require('../neo/neoLogin.js');
 const curConfig = require('../config/index'); // 获取当前项目根目录下的配置文件
 const hasNeoProject = require('../utils/projectUtils/hasNeoProject.js');
 const consoleTag = require('../utils/neoParams').consoleTag;
+const { errorLog, successLog } = require('../utils/common');
 // neo 的 package 文件
 const neoPackage = require('../../package.json');
 
@@ -57,7 +59,7 @@ yargs
     (argv) => {
       if (argv.type && argv.name) {
         if (hasNeoProject()) {
-          console.error(
+          errorLog(
             `${consoleTag}创建自定义组件失败，当前目录（${process.cwd()}）已经是一个自定义组件项目，请勿重复创建。`
           );
           process.exit(1);
@@ -135,7 +137,7 @@ yargs
           // 验证项目名称是否合法
           const { isValid, errors } = validateProjectName(ans.name);
           if (!isValid) {
-            console.error(errors.join('\n'));
+            errorLog(errors.join('\n'));
             process.exit(1);
           }
 
@@ -161,87 +163,125 @@ yargs
       neoConfigInit('neo.config.js');
     }
   )
+  .command(
+    'login',
+    '登录 NeoCRM 平台（OAuth2 授权）',
+    (yargs) => {
+      yargs
+        .reset()
+        .usage(titleTip('Usage') + ': $0 login')
+        .alias('h', 'help');
+    },
+    async () => {
+      try {
+        const loginService = new NeoLoginService(curConfig.neoConfig);
+        await loginService.login();
+      } catch (error) {
+        errorLog(`\n登录失败: ${error.message}`);
+        process.exit(1);
+      }
+    }
+  )
+  .command(
+    'logout',
+    '登出 NeoCRM 平台',
+    (yargs) => {
+      yargs
+        .reset()
+        .usage(titleTip('Usage') + ': $0 logout')
+        .alias('h', 'help');
+    },
+    async () => {
+      try {
+        const loginService = new NeoLoginService(curConfig.neoConfig);
+        await loginService.logout();
+      } catch (error) {
+        errorLog(`\n登出失败: ${error.message}`);
+        process.exit(1);
+      }
+    }
+  )
   .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(
+        '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) {
+                errorLog(errors.join('\n'));
+                process.exit(1);
+              }
+
+              if (!ans.name) {
+                errorLog('自定义组件项目名称不能为空。');
+                process.exit(1);
+              } else {
+                mainAction.createCmpProjectByTemplate(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(
+        '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) {
+                errorLog('自定义组件名称不能为空。');
+                process.exit(1);
+              } else {
+                mainAction.createCmpByTemplate(ans.name);
+              }
+            });
+          }
         }
-      }
-    )
+      );
   })
   .command(
     'pull cmp [options]',
@@ -265,7 +305,7 @@ yargs
         const spinner = ora('正在拉取线上自定义组件列表...').start();
         const cmpList = await neoService.getCustomCmpList();
         if (cmpList.length === 0) {
-          console.error('当前租户暂无任何自定义组件。');
+          errorLog('当前租户暂无任何自定义组件。');
           process.exit(1);
         }
         spinner.stop('线上自定义组件列表拉取成功。');
@@ -283,7 +323,7 @@ yargs
         ];
         inquirer.prompt(questions).then((ans) => {
           if (!ans.cmpType) {
-            console.error('自定义组件名称不能为空。');
+            errorLog('自定义组件名称不能为空。');
             process.exit(1);
           } else {
             mainAction.pullCmp(ans.cmpType, neoService);
@@ -314,7 +354,7 @@ yargs
         const spinner = ora('正在获取线上自定义组件列表...').start();
         const cmpList = await neoService.getCustomCmpList();
         if (cmpList.length === 0) {
-          console.error('当前租户暂无任何自定义组件。');
+          errorLog('当前租户暂无任何自定义组件。');
           process.exit(1);
         }
         spinner.stop('线上自定义组件列表获取成功。');
@@ -332,7 +372,7 @@ yargs
         ];
         inquirer.prompt(questions).then((ans) => {
           if (!ans.cmpType) {
-            console.error('自定义组件名称不能为空。');
+            errorLog('自定义组件名称不能为空。');
             process.exit(1);
           } else {
             mainAction.deleteCmp(ans.cmpType, neoService);
@@ -360,7 +400,7 @@ yargs
       } else {
         const cmpTypes = getCmpTypeByDir();
         if (cmpTypes.length === 0) {
-          console.error('当前自定义组件目录中未找到自定义组件。（./src/components 目录下）');
+          errorLog('当前自定义组件目录中未找到自定义组件。（./src/components 目录下）');
           process.exit(1);
         }
         const cmpTypeChoices = cmpTypes.map((cmpType) => ({
@@ -377,7 +417,7 @@ yargs
         ];
         inquirer.prompt(questions).then((ans) => {
           if (!ans.cmpType) {
-            console.error('未选择要预览的自定义组件。');
+            errorLog('未选择要预览的自定义组件。');
             process.exit(1);
           }
           mainAction.previewCmp(ans.cmpType);
@@ -456,7 +496,7 @@ yargs
       } else {
         const cmpTypes = getCmpTypeByDir();
         if (cmpTypes.length === 0) {
-          console.error('当前自定义组件目录中未找到自定义组件。（./src/components 目录下）');
+          errorLog('当前自定义组件目录中未找到自定义组件。（./src/components 目录下）');
           process.exit(1);
         }
         const cmpTypeChoices = cmpTypes.map((cmpType) => ({
@@ -473,7 +513,7 @@ yargs
         ];
         inquirer.prompt(questions).then((ans) => {
           if (!ans.cmpType) {
-            console.error('未选择要发布的自定义组件。');
+            errorLog('未选择要发布的自定义组件。');
             process.exit(1);
           }
           mainAction.publish2oss(ans.cmpType);
@@ -500,7 +540,7 @@ yargs
       } else {
         const cmpTypes = getCmpTypeByDir();
         if (cmpTypes.length === 0) {
-          console.error('当前自定义组件目录中未找到自定义组件。（./src/components 目录下）');
+          errorLog('当前自定义组件目录中未找到自定义组件。（./src/components 目录下）');
           process.exit(1);
         }
         const cmpTypeChoices = cmpTypes.map((cmpType) => ({
@@ -517,7 +557,7 @@ yargs
         ];
         inquirer.prompt(questions).then((ans) => {
           if (!ans.cmpType) {
-            console.error('未选择要发布的自定义组件。');
+            errorLog('未选择要发布的自定义组件。');
             process.exit(1);
           }
           mainAction.pushCmp(ans.cmpType);
@@ -588,7 +628,7 @@ yargs
   .alias('v', 'version')
   .strict()
   .fail((msg, err, yargs) => {
-    console.error(chalk.red(`\n运行命令时发生错误: ${msg}。\n`));
+    errorLog(`\n运行命令时发生错误: ${msg}。\n`);
     console.log(titleTip('当前可用命令列表：'));
     console.log('');
     // 定义所有可用命令及其描述
@@ -597,8 +637,6 @@ yargs
       // { cmd: 'config init', desc: '创建 neo.config.js 配置文件' },
       { cmd: 'create project [options]', desc: '创建自定义组件项目（含工程代码）' },
       { cmd: 'create cmp [options]', desc: '创建自定义组件' },
-      { cmd: 'pull cmp [options]', desc: '拉取线上自定义组件' },
-      { cmd: 'delete cmp [options]', desc: '删除线上自定义组件' },
       { cmd: 'preview [options]', desc: '预览指定自定义组件（仅预览组件本身内容）' },
       // { cmd: 'dev', desc: '开启本地调试模式' },
       { cmd: 'linkDebug', desc: '开启外链调试模式（在线上页面设计器端调试）' },
@@ -606,8 +644,12 @@ yargs
       // { cmd: 'build2lib', desc: '构建 UMD 模块' },
       // { cmd: 'build2esm', desc: '构建 ESM 模块' },
       // { cmd: 'publish2oss [options]', desc: '发布到oss' },
-      { cmd: 'push cmp [options]', desc: '构建并发布自定义组件到 NeoCRM 平台' },
       // { cmd: 'inspect', desc: '输出当前配置文件' },
+      { cmd: 'login', desc: '登录 NeoCRM 平台（OAuth2 授权）' },
+      { cmd: 'logout', desc: '登出 NeoCRM 平台' },
+      { cmd: 'pull cmp [options]', desc: '拉取线上自定义组件' },
+      { cmd: 'delete cmp [options]', desc: '删除线上自定义组件' },
+      { cmd: 'push cmp [options]', desc: '构建并发布自定义组件到 NeoCRM 平台' },
       { cmd: 'open [options]', desc: '使用 Cursor 或 VSCode 打开项目' }
     ];
     commands.forEach(({ cmd, desc }) => {

package/src/module/main.js

@@ -19,6 +19,7 @@ const createCmpProjectByTemplate = require('../utils/projectUtils/createCmpProje
 const pullCmp = require('../utils/cmpUtils/pullCmp');
 const deleteCmp = require('../utils/cmpUtils/deleteCmp');
 const openProject = require('../utils/projectUtils/openProject');
+const { errorLog, successLog } = require('../utils/common');
 
 const getValue = (originValue, defaultValue) => {
   return originValue !== undefined ? originValue : defaultValue;
@@ -109,7 +110,7 @@ function setupEntries(config, options) {
       console.info('已自动生成 entry 入口配置：', entries);
     }
   } catch (error) {
-    console.error(error.message);
+    errorLog(error.message);
     process.exit(1);
   }
 
@@ -155,7 +156,7 @@ module.exports = {
   createCmpByTemplate,
   dev: () => {
     if (!curConfig.dev) {
-      console.error('未找到 dev 相关配置。');
+      errorLog('未找到 dev 相关配置。');
       process.exit(1);
     }
     akfun.dev(curConfig, consoleTag);
@@ -163,11 +164,11 @@ module.exports = {
   previewCmp: (cmpName) => {
     // 预览组件本身内容
     if (!cmpName) {
-      console.error('请输入要预览的组件名称。');
+      errorLog('请输入要预览的组件名称。');
       process.exit(1);
     }
     if (!curConfig.preview) {
-      console.error('未找到 preview 相关配置。');
+      errorLog('未找到 preview 相关配置。');
       process.exit(1);
     }
     curConfig.dev = Object.assign(curConfig.dev, curConfig.preview); // 将 preview 设置给 dev
@@ -178,7 +179,7 @@ module.exports = {
   linkDebug: () => {
     // 外链调试模式
     if (!curConfig.linkDebug) {
-      console.error('未找到 debug 相关配置。');
+      errorLog('未找到 debug 相关配置。');
       process.exit(1);
     }
     // 将 linkDebug 设置给 dev

package/src/module/neoInitByCopy.js

@@ -4,6 +4,7 @@ const { consoleTag } = require('../utils/neoParams'); // 输出标记
 const { replaceInPackage } = require('../utils/replaceInPackage');
 const { resetPackageVersion } = require('../utils/resetPackageVersion');
 const autoEntryRootDir = require('../utils/autoEntryRootDir');
+const { errorLog } = require('../utils/common');
 
 const templateList = {
   react: {
@@ -14,7 +15,7 @@ const templateList = {
     projectName: 'react-ts-custom-cmp-template',
     dir: path.resolve(__dirname, '../template/react-ts-custom-cmp-template')
   },
-  'antd': {
+  antd: {
     projectName: 'antd-custom-cmp-template',
     dir: path.resolve(__dirname, '../template/antd-custom-cmp-template')
   },
@@ -22,7 +23,7 @@ const templateList = {
     projectName: 'echarts-custom-cmp-template',
     dir: path.resolve(__dirname, '../template/echarts-custom-cmp-template')
   },
-  'neo': {
+  neo: {
     projectName: 'neo-custom-cmp-template',
     dir: path.resolve(__dirname, '../template/neo-custom-cmp-template')
   },
@@ -54,7 +55,7 @@ const neoInitByCopy = function (type, projectName) {
       // 自动切换到项目根目录
       autoEntryRootDir(finalProjectPath);
     })
-    .catch((err) => console.error(`${consoleTag}自定义组件模板下载失败：`, err));
+    .catch((err) => errorLog(`${consoleTag}自定义组件模板下载失败：`, err));
 };
 
 module.exports = neoInitByCopy;