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

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);
 

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/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）

package/src/template/antd-custom-cmp-template/neo.config.js

@@ -41,10 +41,12 @@ module.exports = {
   // 用于添加 Neo 共享依赖模块和剔除模块
   /*
   neoCommonModule: {
-    remotes: ['chart-widget'], // 远程自定义组件，表示当前自定义组件会用到的远程组件
-    neoExternals: ['chart-widget'], // 自定义组件中需要剔除的模块，仅支持数组写法，需要和 remotes 配合使用
     // neoExports: ['xxModule'], // 自定义组件 共享出来的模块，支持数组和对象形式
-    // neoExports: { 'xxModule': path.resolve('./src/components/xxModule') }, // 对象写法
+    neoExports: { // 对象写法
+      'xx-module': path.resolve('./src/components/xx-module'), // 导出 xx组件 或 xx模块
+    },
+    // remoteDeps: ['xxCmpType'], // 远程依赖组件，表示当前自定义组件会用到的依赖组件，需要和 neoExternals 配合使用
+    // neoExternals: ['xxModule'], // 自定义组件中需要剔除的模块（仅支持数组写法）
   },
   */
   preview: {
@@ -95,23 +97,29 @@ module.exports = {
     }
     */
   },
-  publish2oss: {
-    // 用于构建并发布至 OSS 的相关配置
+  pushCmp: {
+    // 用于构建并发布至 NeoCRM 的相关配置
+    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 授权配置
+    authConfig: {
+      client_id: 'xx', // 客户端 ID，从创建连接器的客户端信息中获取（Client_Id）
+      client_secret: 'xxx', // 客户端秘钥，从创建连接器的客户端信息中获取（Client_Secret）
+      username: 'xx', // 用户在销售易系统中的用户名
+      /**
+       * password 为 用户在销售易系统中的账号密码加上 8 位安全令牌。
+       * 例如，用户密码为 123456，安全令牌为 ABCDEFGH，则 password 的值应为 123456ABCDEFGH。
+       */
+      password: 'xx xx' // 用户账户密码 + 8 位安全令牌
+    },
     /*
     【特别说明】以下配置项都自带默认值，非必填。如需自定义请自行配置。
     NODE_ENV: 'production',
     entry: { // 根据 src/components 目录下的文件自动生成 entry 相关配置
-      InfoCardModel: './src/components/info-card/model.ts',
-      infoCard: './src/components/info-card/register.ts'
+      InfoCardModel: './src/components/entity-form/model.ts',
+      infoCard: './src/components/entity-form/register.ts'
     },
     cssExtract: false, // 不额外提取css文件
-    ossType: 'ali', // oss类型：ali、baidu
-    ossConfig: {
-      endpoint: 'https://oss-cn-beijing.aliyuncs.com',
-      AccessKeyId: 'xxx',
-      AccessKeySecret: 'xx',
-      bucket: 'neo-widgets' // 存储桶名称
-    },
     assetsRoot: resolve('dist') // 上传指定目录下的脚本文件
     */
   },

package/src/template/antd-custom-cmp-template/package.json

@@ -10,9 +10,9 @@
   "author": "wibetter",
   "license": "MIT",
   "scripts": {
-    "preview": "neo preview --cmpType=data-dashboard",
+    "preview": "neo preview",
     "linkDebug": "neo linkDebug",
-    "publish2oss": "neo publish2oss",
+    "pushCmp": "neo pushCmp",
     "format": "prettier --write \"src/**/**/*.{js,jsx,ts,tsx,vue,scss,json}\""
   },
   "files": [

package/src/template/develop/neo-custom-cmp-template/neo.config.js

@@ -46,8 +46,8 @@ module.exports = {
       'chart-widget': path.resolve('./src/components/chart-widget'), // 导出图表自定义组件
       'neo-register': 'neo-register', // 导出 Neo 注册模块
     },
+    // remoteDeps: ['xxModule'], // 远程依赖组件，表示当前自定义组件会用到的远程依赖组件，需要和 neoExternals 配合使用
     // neoExternals: ['xxModule'], // 自定义组件中需要剔除的模块，仅支持数组写法
-    // remotes: ['xxModule'], // 远程组件，表示当前自定义组件会用到的远程组件，需要和 neoExternals 配合使用
   },
   */
   preview: {

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

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

package/src/template/echarts-custom-cmp-template/neo.config.js

@@ -46,8 +46,8 @@ module.exports = {
       'chart-widget': path.resolve('./src/components/chart-widget'), // 导出图表自定义组件
       'neo-register': 'neo-register', // 导出 Neo 注册模块
     },
-    // remotes: ['xxModule'], // 远程组件，表示当前自定义组件会用到的远程组件
-    // neoExternals: ['xxModule'], // 自定义组件中需要剔除的模块，仅支持数组写法，需要和 remotes 配合使用
+    // remoteDeps: ['xxCmpType'], // 远程依赖组件，表示当前自定义组件会用到的依赖组件，需要和 neoExternals 配合使用
+    // neoExternals: ['xxModule'], // 自定义组件中需要剔除的模块，仅支持数组写法
   },
   //*/
   preview: {
@@ -98,23 +98,29 @@ module.exports = {
     }
     */
   },
-  publish2oss: {
-    // 用于构建并发布至 OSS 的相关配置
+  pushCmp: {
+    // 用于构建并发布至 NeoCRM 的相关配置
+    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 授权配置
+    authConfig: {
+      client_id: 'xx', // 客户端 ID，从创建连接器的客户端信息中获取（Client_Id）
+      client_secret: 'xxx', // 客户端秘钥，从创建连接器的客户端信息中获取（Client_Secret）
+      username: 'xx', // 用户在销售易系统中的用户名
+      /**
+       * password 为 用户在销售易系统中的账号密码加上 8 位安全令牌。
+       * 例如，用户密码为 123456，安全令牌为 ABCDEFGH，则 password 的值应为 123456ABCDEFGH。
+       */
+      password: 'xx xx' // 用户账户密码 + 8 位安全令牌
+    },
     /*
     【特别说明】以下配置项都自带默认值，非必填。如需自定义请自行配置。
     NODE_ENV: 'production',
     entry: { // 根据 src/components 目录下的文件自动生成 entry 相关配置
-      InfoCardModel: './src/components/info-card/model.ts',
-      infoCard: './src/components/info-card/register.ts'
+      InfoCardModel: './src/components/entity-form/model.ts',
+      infoCard: './src/components/entity-form/register.ts'
     },
     cssExtract: false, // 不额外提取css文件
-    ossType: 'ali', // oss类型：ali、baidu
-    ossConfig: {
-      endpoint: 'https://oss-cn-beijing.aliyuncs.com',
-      AccessKeyId: 'xxx',
-      AccessKeySecret: 'xx',
-      bucket: 'neo-widgets' // 存储桶名称
-    },
     assetsRoot: resolve('dist') // 上传指定目录下的脚本文件
     */
   },

package/src/template/echarts-custom-cmp-template/package.json

@@ -10,9 +10,9 @@
   "author": "wibetter",
   "license": "MIT",
   "scripts": {
-    "preview": "neo preview --cmpType=chart-widget",
+    "preview": "neo preview",
     "linkDebug": "neo linkDebug",
-    "publish2oss": "neo publish2oss",
+    "pushCmp": "neo pushCmp",
     "format": "prettier --write \"src/**/**/*.{js,jsx,ts,tsx,vue,scss,json}\""
   },
   "files": [

package/src/template/empty-cmp/index.tsx

@@ -0,0 +1,51 @@
+import * as React from 'react';
+import './style.scss'; // 组件内容样式
+
+interface CustomCmpProps {
+  title: string;
+  backgroundImage: string;
+  imgCount: number;
+  commentCount: number;
+  data?: any;
+}
+
+export default class CustomCmp extends React.PureComponent<CustomCmpProps> {
+  constructor(props: CustomCmpProps) {
+    super(props);
+    this.agreeDataFormat = this.agreeDataFormat.bind(this);
+  }
+
+  agreeDataFormat(agreeData: number) {
+    if (agreeData && agreeData <= 9999) {
+      return agreeData;
+    }
+    if (agreeData && agreeData > 9999) {
+      return `${Math.floor(agreeData / 1000) / 10}w`;
+    }
+    return '';
+  }
+
+  render() {
+    const { title, backgroundImage, imgCount, commentCount } = this.props;
+    console.log('当前自定义组件：', this.props, this);
+
+    const curBackgroundImage =
+      backgroundImage || 'https://neo-widgets.bj.bcebos.com/NeoCRM.jpg';
+    return (
+      <div className="custom-cmp-container">
+        <div className="news-title">
+          {title ||
+            '营销服全场景智能CRM，帮助企业搭建数字化客户经营平台，实现业绩高质量增长。'}
+        </div>
+        <div className="news-info">
+          <div className="left media-mark">NeoCRM · 低代码平台</div>
+          {commentCount && commentCount > 0 && (
+            <div className="cmt-num right">
+              {this.agreeDataFormat(commentCount)}评
+            </div>
+          )}
+        </div>
+      </div>
+    );
+  }
+}

package/src/template/empty-cmp/model.ts

@@ -0,0 +1,77 @@
+/**
+ * @file 自定义组件对接编辑器的描述文件
+ */
+export class CustomCmpModel {
+  /**
+   * cmpType 为自定义组件名称，用于标识组件的唯一性
+   * 在构建时根据当前组件目录名称自动生成
+   */
+  // cmpType: string = 'xx-custom-cmp';
+
+  // 组件名称，用于设置在编辑器左侧组件面板中展示的名称
+  label: string = 'xx组件';
+
+  // 组件描述，用于设置在编辑器左侧组件面板中展示的描述
+  description: string = 'xx自定义组件详细描述';
+
+  // 分类标签，用于设置在编辑器左侧组件面板哪个分类中展示（可设置多个分类标签）
+  tags: string[] = ['自定义组件'];
+
+  // 组件图标，用于设置在编辑器左侧组件面板中展示的图标
+  iconSrc: string = 'https://neo-widgets.bj.bcebos.com/custom-widget.svg';
+
+  // 初次插入页面的默认属性数据
+  defaultComProps = {
+    title:
+      '营销服全场景智能CRM，帮助企业搭建数字化客户经营平台，实现业绩高质量增长。',
+    label: '信息卡片',
+    backgroundImage: 'https://neo-widgets.bj.bcebos.com/NeoCRM.jpg',
+    imgCount: 3,
+    commentCount: 2025,
+  };
+
+  // 设计器端预览时展示的默认数据
+  previewComProps = {
+    label: '信息卡片',
+  };
+
+  /**
+   * 组件面板配置，用于生成编辑器右侧属性配置面板内容
+   */
+  propsSchema = [
+    {
+      type: 'textarea',
+      name: 'title',
+      label: '卡片title',
+      value:
+        '营销服全场景智能CRM，帮助企业搭建数字化客户经营平台，实现业绩高质量增长。',
+    },
+    {
+      type: 'text',
+      name: 'backgroundImage',
+      label: '展示图片',
+      value: 'https://neo-widgets.bj.bcebos.com/NeoCRM.jpg',
+    },
+    {
+      type: 'number',
+      name: 'imgCount',
+      label: '图片数量',
+      value: 3,
+    },
+    {
+      type: 'number',
+      name: 'commentCount',
+      label: '评论数',
+      value: 2025,
+    },
+  ];
+
+  // 支持 函数式写法：propsSchemaCreator，com 为组件实例。优先级比 propsSchema 高
+  /*
+  propsSchemaCreator = (com: any) => {
+    return [];
+  };
+  */
+}
+
+export default CustomCmpModel;

package/src/template/empty-cmp/style.scss

@@ -0,0 +1,72 @@
+:root {
+  --padding-bottom: 12px;
+}
+
+.custom-cmp-container {
+  position: relative;
+  box-sizing: border-box;
+
+  /* border-bottom: 1px solid #ececec; */
+  margin: 6px 12px;
+  padding: 6px var(--padding-bottom);
+  background-color: #fff;
+
+  .news-title {
+    padding: 6px 0;
+    font-family: PingFangSC-Regular;
+    font-size: 16px;
+    line-height: 22px;
+    color: #5f5e5e;
+  }
+
+  .item-imgbox {
+    position: relative;
+    height: 395px;
+    background: #f0f0f0;
+    cursor: pointer;
+    box-sizing: border-box;
+    text-align: center;
+    overflow: hidden;
+
+    .news-img {
+      width: 100%;
+      height: 100%;
+      box-sizing: border-box;
+      background-size: contain;
+    }
+
+    .img-count {
+      position: absolute;
+      top: 0;
+      right: 0;
+      padding: 6px 8px;
+      color: #fff;
+      min-width: 60px;
+      text-align: center;
+      line-height: 1.2;
+      background: rgb(0 0 0 / 40%);
+      font-size: 25px;
+      box-sizing: border-box;
+      overflow: hidden;
+    }
+  }
+
+  .news-info {
+    font-family: PingFangSC-Light;
+    height: 28px;
+    box-sizing: border-box;
+    display: flex;
+    justify-content: space-between;
+    align-items: center;
+  }
+
+  .media-mark,
+  .cmt-num {
+    display: inline-block;
+    height: 28px;
+    line-height: 28px;
+    font-family: PingFangSC-Light;
+    font-size: 18px;
+    color: #828282;
+  }
+}

package/src/template/empty-custom-cmp-template/.prettierrc.js

@@ -0,0 +1,12 @@
+/*
+  prettier 配置文件
+  更多配置信息：https://prettier.io/docs/en/options.html
+ */
+module.exports = {
+  semi: true, // Semicolons 分号，默认需要分号
+  tabWidth: 2, // 空格，默认 2,
+  useTabs: false,
+  singleQuote: true, // 单引号还是双引号，默认为false 双引号
+  trailingComma: 'all', // 逗号
+  jsxBracketSameLine: false, // 默认为false，Put the > of a multi-line JSX element at the end of the last line instead of being alone on the next line (does not apply to self closing elements).
+};

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

@@ -0,0 +1,45 @@
+### 目录说明
+- src: 自定义组件源码；
+- src/assets: 存放组件静态资源，比如 css、img等；
+- src/components: 存放自定义组件代码，每个自定义组件以自身名称（cmpType 数值）作为目录进行存放；
+- neo.config.js: neo-cmp-cli 配置文件。
+
+### 组件开发规范
+- 存放在 src/components 目录下的自定义组件，默认 index 为自定义组件源码入口文件，register.[tj]s 为注册 自定义组件的脚本文件，model.[tj]s 为自定义组件的模型文件（对接页面设计器需要）；
+- 当 neo.config.js 中的 entry 为空或者不存在时，cli 将根据 src/components 目录下的自定义组件结构生成对应的 entry 配置（可在命令控制台查看生成的 entry 配置）；
+- 自定义组件中可用的配置项类型 请见 [当前可用表单项](https://github.com/wibetter/neo-register/blob/master/docs/FormItemType.md)；
+- 自定义组件最外层请设置一个唯一的 ClassName（比如 xx-cmpType-container），所有内容样式请放在该 ClassName 中，避免自定义组件样式相互干扰；
+- 默认开启代码规范检测（含样式内容），如需关闭，请调整 neo.config.js 相关配置；
+- 请使用 react 16版本。
+
+### 自定义组件注册器使用说明
+- [neo-register 使用说明](https://www.npmjs.com/package/neo-register?activeTab=readme)
+备注：预览、调试（linkDebug）和构建发布时 cli 会自动创建对应的注册文件（含 neo-register 的使用），用户无需关注 neo-register。
+
+### 开发说明
+
+1. **安装依赖**
+```bash
+$ npm i 或者 yarn
+```
+
+2. **preview: 组件预览模式（带热更新）**
+> preview模式：用于预览自定义组件内容。
+```bash
+$ npm run preview
+```
+
+3. **linkDebug: 外链调试（在线上页面设计器端预览自定义组件）**
+> linkDebug模式：用于在线上页面设计器中预览和调试自定义组件。
+```bash
+$ npm run linkDebug
+```
+
+4. **发布到 NeoCRM 中**
+> 需要确保 package.json 中的 name 值唯一，version 值不重复。
+```bash
+$ npm run pushCmp
+```
+
+### 配置项说明（neo-cmp-cli）
+[请查看neo-cmp-cli](https://github.com/wibetter/neo-cmp-cli)

package/src/template/empty-custom-cmp-template/commitlint.config.js

@@ -0,0 +1,59 @@
+/**
+ * https://www.npmjs.com/package/@commitlint/config-conventional\
+ *
+ * Git提交规范-配置文件
+ * Commit message 由Header、Body 和 Footer三个部分组成，其格式如下：
+ *  <type>(<scope>): <subject>
+ *  <BLANK LINE>
+ *   <body>
+ *  <BLANK LINE>
+ *  <footer>
+ *
+ *【备注】
+ * type 用于说明 commit 的类别，常用下面 7 个标识：
+ * scope 用于说明当前功能点作用于哪个页面或者哪个功能模块；
+ * subject 用于简短的描述当前commit，不超过50个字符；
+ * body 用于填写对本次 commit 的详细描述，可以分成多行；
+ * footer 不兼容变动声明，或者关闭 Issue。
+ *
+ * 【type类型取值类型】
+ * feat：新功能（feature）
+ * fix：功能优化
+ * bug：修补bug
+ * docs：文档（documentation）
+ * style：格式（不影响代码运行的变动）
+ * refactor：重构（即不是新增功能，也不是修改bug的代码变动）
+ * test：增加测试
+ * chore：构建过程或辅助工具的变动
+ * build：影响构建系统或外部依赖项的更改（示例范围：gulp，broccoli，npm）
+ * ci：对 CI 配置文件和脚本的更改（示例范围：Travis，Circle，BrowserStack，SauceLabs）
+ * perf：改进性能的代码更改
+ *
+ */
+
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'type-enum': [
+      2,
+      'always',
+      [
+        'feat',
+        'fix',
+        'bug',
+        'docs',
+        'style',
+        'refactor',
+        'test',
+        'chore',
+        'perf',
+        'build',
+        'ci',
+      ],
+    ],
+    'type-empty': [2, 'never'],
+    'scope-empty': [1, 'never'],
+    'subject-full-stop': [0, 'never'],
+    'subject-case': [0, 'never'],
+  },
+};