neo-cmp-cli 1.8.2 → 1.8.3

package/src/template/neo-custom-cmp-template/tsconfig.json

@@ -1,49 +0,0 @@
-{
-  "compilerOptions": {
-    "experimentalDecorators": true,
-    "target": "esnext",
-    "module": "esnext",
-    "allowJs": false,
-    "jsx": "react",
-    "declaration": false,
-    "noEmit": false,
-    "importHelpers": true,
-    "isolatedModules": false,
-    "strict": false,
-    "noImplicitAny": true,
-    "strictNullChecks": true,
-    "noImplicitThis": true,
-    "noUnusedLocals": false,
-    "noImplicitReturns": true,
-    "moduleResolution": "node",
-    "baseUrl": "./",
-    "paths": {
-      "@": [
-        "./src"
-      ],
-      "@assets/*": [
-        "src/assets/*"
-      ],
-      "@components/*": [
-        "src/components/*"
-      ],
-      "$utils/*": [
-        "src/utils/*"
-      ]
-    },
-    "typeRoots": [
-      "./@types",
-      "./node_modules/@types"
-    ],
-    "allowSyntheticDefaultImports": true,
-    "esModuleInterop": true,
-    "forceConsistentCasingInFileNames": true
-  },
-  "include": [
-    "src",
-    "test"
-  ],
-  "exclude": [
-    "node_modules"
-  ]
-}

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

@@ -1,12 +0,0 @@
-/*
-  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/react-custom-cmp-template/README.md

@@ -1,154 +0,0 @@
-### 目录说明
-- src: 自定义组件源码；
-- src/assets: 存放组件静态资源，比如 css、img等；
-- src/components: 存放自定义组件代码，每个自定义组件以自身名称（cmpType 数值）作为目录进行存放；
-- src/components/xxCmp/index: 自定义组件的内容文件；
-- src/components/xxCmp/model: 自定义组件的模型文件，用于对接页面设计器；
-- 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 push cmp`、`neo pull cmp`、`neo delete cmp` 等命令与 NeoCRM 平台交互时，需要配置授权信息。
-
-#### 方式一：OAuth2 登录授权（推荐）
-
-OAuth2 授权码模式更加安全可靠，无需用户配置账户名和密码。
-
-##### 使用步骤
-
-1. **登录 NeoCRM 平台**
-   ```bash
-   neo login
-   ```
-   
-   执行流程：
-   - 自动打开浏览器访问授权页面
-   - 在浏览器中输入 NeoCRM 账号密码进行登录（需选择对应的租户）
-   - 授权成功后自动跳转回本地（附带 code）
-   - cli 端 通过 code 获取 Token，并自动保存到项目的 `.neo-cli/token.json` 文件中
-
-2. **登出 NeoCRM 平台**
-   ```bash
-   neo logout
-   ```
-   
-   功能：清除本地保存的 token 文件，下次使用需要重新登录。
-
-##### 配置示例
-
-```javascript
-// neo.config.js
-module.exports = {
-  neoConfig: {
-    neoBaseURL: 'https://crm-cd.xiaoshouyi.com', // 平台根地址（默认：https://crm.xiaoshouyi.com）
-    // 登录授权 URL（用于获取 code）
-    loginURL: 'https://login-cd.xiaoshouyi.com/auc/oauth2/auth',
-    tokenAPI: 'https://login-cd.xiaoshouyi.com/auc/oauth2/token', // Token 获取接口地址
-  },
-}
-```
-
-##### Token 有效期
-
-- **access_token**：默认有效期 2 小时
-- **refresh_token**：默认有效期 30 天
-- 系统会在 access_token 过期前 5 分钟自动刷新
-- 如果 refresh_token 也过期，需要重新执行 `neo login`
-
-##### 常见问题
-
-**Q1: 浏览器无法自动打开怎么办？**  
-A: 命令行会输出授权 URL，手动复制到浏览器中打开即可。
-
-**Q2: Token 刷新失败怎么办？**  
-A: 如果 refresh_token 也过期（默认 30 天），需要重新执行 `neo login`。同时检查网络连接是否正常。
-
-**Q3: 授权登录后没有正常跳回 redirect_uri**  
-A: 可能被浏览器安装的插件影响，目前已知会影响授权登录的浏览器插件有：Neo UI Extension，请关闭插件后重试。
-
-#### 方式二：密码授权配置
-
-在项目根目录的 `neo.config.js` 文件中添加 NeoCRM 平台授权配置：
-
-```javascript
-module.exports = {
-  neoConfig: {
-    neoBaseURL: 'https://crm-cd.xiaoshouyi.com', // 平台根地址（默认：https://crm.xiaoshouyi.com）
-    tokenAPI: 'https://login-cd.xiaoshouyi.com/auc/oauth2/token', // Token 获取接口地址
-    // NeoCRM 授权配置
-    auth: {
-      client_id: 'xx', // 客户端 ID，从创建连接器的客户端信息中获取（Client_Id）
-      client_secret: 'xxx', // 客户端秘钥，从创建连接器的客户端信息中获取（Client_Secret）
-      username: 'xx', // 用户在销售易系统中的用户名
-      /**
-       * password 为 用户在销售易系统中的账号密码加上 8 位安全令牌。
-       * 例如，用户密码为 123456，安全令牌为 ABCDEFGH，则 password 的值应为 123456ABCDEFGH。
-       */
-      password: 'xx xx' // 用户账户密码 + 8 位安全令牌
-    },
-  },
-}
-```
-
-##### 授权配置获取方式
-
-1. **客户端 ID 和客户端秘钥**：需通过创建连接器获取
-   - 访问 [销售易文档中心](https://doc.xiaoshouyi.com) / 创建连接器
-   - 创建连接器后，从客户端信息中获取 `Client_Id` 和 `Client_Secret`
-
-2. **安全令牌**：如何获取安全令牌
-   - 访问 [销售易文档中心](https://doc.xiaoshouyi.com) / OAuth安全认证 / 密码模式 / 获取令牌
-   - 按照文档说明获取 8 位安全令牌
-   - `password` 字段 = 用户账户密码 + 8 位安全令牌（直接拼接，无空格或分隔符）
-
-#### OAuth2 模式 vs 密码模式
-
-| 特性 | OAuth2 授权码模式 | 密码模式 |
-|------|------------------|---------|
-| 安全性 | ✅ 高（无需在配置文件中存储密码） | ⚠️ 较低（需要配置密码和安全令牌） |
-| Token 刷新 | ✅ 自动刷新 | ✅ 自动刷新 |
-| 有效期 | 2 小时（可自动刷新） | 永不过期 |
-| 推荐程度 | ⭐⭐⭐⭐⭐ | ⭐⭐⭐ |
-
----
-
-### 配置项说明（neo-cmp-cli）
-[请查看neo-cmp-cli](https://www.npmjs.com/package/neo-cmp-cli)

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

@@ -1,59 +0,0 @@
-/**
- * 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'],
-  },
-};

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

@@ -1,137 +0,0 @@
-'use strict';
-const path = require('path');
-
-// 统一路径解析
-function resolve(dir) {
-  return path.resolve(__dirname, dir);
-}
-
-// 包括生产和开发的环境配置信息
-module.exports = {
-  settings: {
-    enableESLint: false, // 调试模式是否开启ESLint，默认开启ESLint检测代码格式
-    enableESLintFix: false, // 是否自动修正代码格式，默认不自动修正
-    enableStyleLint: false, // 是否开启StyleLint，默认开启ESLint检测代码格式
-    enableStyleLintFix: false, // 是否需要StyleLint自动修正代码格式
-  },
-  webpack: {
-    resolve: {
-      // webpack的resolve配置
-      extensions: ['.js', '.jsx', '.ts', '.tsx', '.umd.js', '.min.js', '.json'], // 用于配置webpack在尝试过程中用到的后缀列表
-      alias: {
-        '@': resolve('src'),
-        $assets: resolve('src/assets'),
-        $public: resolve('public'),
-      },
-      // conditionNames: ['require']
-    },
-    // sassResources中的sass文件会自动注入每一个sass文件中
-    sassResources: [
-      resolve('./src/assets/css/common.scss'),
-      resolve('./src/assets/css/mixin.scss'),
-    ],
-    // createDeclaration: true, // 打包时是否创建ts声明文件
-    ignoreNodeModules: false, // 打包时是否忽略 node_modules
-    // allowList: [], // ignoreNodeModules 为 true 时生效
-    // projectDir: ['src'],
-    // template: resolve('./public/template.html'), // 自定义html模板
-    // plugins: [], // 用于添加自定义 plugins
-    // cssLoaderUrlDir: 'antd',
-    cssLoaderOption: {
-      // modules: true
-    },
-    moduleRules: [],
-  },
-  // 用于添加 Neo 共享依赖模块的配置信息
-  /*
-  neoCommonModule: {
-    // exports: ['xxModule'], // 数组写法，用于导出当前自定义组件中的第三方依赖模块
-    exports: { // 对象写法，可用于导出自定义组件中的某个内容模块（需要使用绝对路径导出）
-      'xxModule': path.resolve('./src/components/xxModule'), // 导出 xx组件 或 xx模块
-    },
-    // remoteDeps: ['xxCmpType'], // 远程依赖组件，表示当前自定义组件会用到的依赖组件，需要和 externals 配合使用
-    // externals: ['xxModule'], // 自定义组件中需要剔除的模块，仅支持数组写法
-  },
-  */
-  preview: {
-    // 用于开启本地预览模式的相关配置信息
-    /*
-    【特别说明】以下配置项都自带默认值，非必填。如需自定义请自行配置。
-    NODE_ENV: 'development',
-    port: 80, // 设置基础端口，如果被占用则自动寻找可用端口
-    assetsPublicPath: '/', // 设置静态资源的引用路径（根域名+路径）
-    assetsSubDirectory: '',
-    hostname: 'localhost',
-    proxyTable: {
-      '/apiTest': {
-        target: 'http://api-test.com.cn', // 不支持跨域的接口根地址
-        ws: true,
-        changeOrigin: true,
-      },
-    }
-    */
-  },
-  linkDebug: {
-    // 用于开启本地调试模式的相关配置信息
-    /*
-    【特别说明】以下配置项都自带默认值，非必填。如需自定义请自行配置。
-    entry: { // entry 会根据 src/components 目录下的文件自动生成
-      // 外链调试（在线上页面设计器端预览自定义组件）
-      index: [
-        './src/components/xxCmp/register.js',
-        './src/components/xxCmp/model.js',
-      ],
-    },
-    NODE_ENV: 'development',
-    port: 80, // 设置基础端口，如果被占用则自动寻找可用端口
-    assetsPublicPath: '/', // 设置静态资源的引用路径（根域名+路径）
-    assetsSubDirectory: '',
-    hostname: 'localhost',
-    proxyTable: {
-      '/apiTest': {
-        target: 'http://api-test.com.cn', // 不支持跨域的接口根地址
-        ws: true,
-        changeOrigin: true,
-      },
-    }
-    */
-  },
-  // 授权码授权模式下的 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: {
-    // 用于构建并发布至 NeoCRM 的相关配置
-    /*
-    【特别说明】以下配置项都自带默认值，非必填。如需自定义请自行配置。
-    NODE_ENV: 'production',
-    entry: { // 根据 src/components 目录下的文件自动生成 entry 相关配置
-      InfoCardModel: './src/components/xxCmp/model.ts',
-      infoCard: './src/components/xxCmp/register.ts'
-    },
-    cssExtract: false, // 不额外提取css文件
-    assetsRoot: resolve('dist') // 上传指定目录下的脚本文件
-    */
-  },
-};

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

@@ -1,57 +0,0 @@
-{
-  "name": "react-custom-cmp-template",
-  "version": "1.1.0",
-  "description": "neo自定义组件模板（react技术栈）",
-  "framework": "react-js",
-  "keywords": [
-    "自定义组件模板",
-    "react技术栈",
-    "neo自定义组件"
-  ],
-  "author": "wibetter",
-  "license": "MIT",
-  "scripts": {
-    "preview": "neo preview",
-    "linkDebug": "neo linkDebug",
-    "pushCmp": "neo push cmp",
-    "format": "prettier --write \"src/**/**/*.{js,jsx,ts,tsx,vue,scss,json}\""
-  },
-  "files": [
-    "dist/*"
-  ],
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged",
-      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
-    }
-  },
-  "lint-staged": {
-    "src/**/**/*.{js,jsx,ts,tsx,vue,scss,json}": [
-      "prettier --write"
-    ]
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://git@github.com:wibetter/react-custom-cmp-template.git"
-  },
-  "bugs": {
-    "url": "https://github.com/wibetter/react-custom-cmp-template/issues"
-  },
-  "dependencies": {
-    "neo-register": "^1.0.7",
-    "react": "^16.9.0",
-    "react-dom": "^16.9.0"
-  },
-  "devDependencies": {
-    "@commitlint/cli": "^8.3.5",
-    "@commitlint/config-conventional": "^9.1.1",
-    "neo-cmp-cli": "^1.8.0",
-    "husky": "^4.2.5",
-    "lint-staged": "^10.2.9",
-    "prettier": "^2.0.5"
-  },
-  "engines": {
-    "node": ">= 10.13.0",
-    "npm": ">= 6.4.1"
-  }
-}