npm - neo-cmp-cli - Versions diffs - 1.3.10 → 1.5.0-beta.10 - Mend

neo-cmp-cli 1.3.10 → 1.5.0-beta.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (68) hide show

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

@@ -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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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 ADDED Viewed

@@ -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'],
+  },
+};

package/src/template/empty-custom-cmp-template/neo.config.js ADDED Viewed

@@ -0,0 +1,126 @@
+'use strict';
+const path = require('path');
+// 统一路径解析
+function resolve(dir) {
+  return path.resolve(__dirname, dir);
+}
+// 包括生产和开发的环境配置信息
+module.exports = {
+  settings: {
+    enableESLint: true, // 调试模式是否开启ESLint，默认开启ESLint检测代码格式
+    enableESLintFix: true, // 是否自动修正代码格式，默认不自动修正
+    enableStyleLint: false, // 是否开启StyleLint，默认开启ESLint检测代码格式
+    enableStyleLintFix: false, // 是否需要StyleLint自动修正代码格式
+  },
+  webpack: {
+    target: ['web', 'es5'], // 指定目标环境为 web 和 es5，确保兼容性
+    resolve: {
+      // webpack的resolve配置
+      extensions: ['.js', '.jsx', '.ts', '.tsx', '.umd.js', '.min.js', '.json'], // 用于配置webpack在尝试过程中用到的后缀列表
+      alias: {
+        '@': resolve('src'),
+        $assets: resolve('src/assets'),
+        $public: resolve('public'),
+      },
+    },
+    // 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: [],
+    // babelPlugins: [],
+  },
+  // 用于添加 Neo 共享依赖模块的配置信息
+  /*
+  neoCommonModule: {
+    // neoExports: ['xxModule'], // 自定义组件 共享出来的模块，支持数组和对象形式
+    neoExports: { // 对象写法
+      'xx-module': path.resolve('./src/components/xx-module'), // 导出 xx组件 或 xx模块
+    },
+    // remoteDeps: ['xxCmpType'], // 远程依赖组件，表示当前自定义组件会用到的依赖组件，需要和 neoExternals 配合使用
+    // neoExternals: ['xxModule'], // 自定义组件中需要剔除的模块，仅支持数组写法
+  },
+  */
+  preview: {
+    // 用于开启本地预览模式的相关配置信息
+    /*
+    【特别说明】以下配置项都自带默认值，非必填。如需自定义请自行配置。
+    entry: { // 根据 src/components 目录下的文件自动生成 entry 相关配置
+      // 本地预览自定义组件内容
+      index: './src/preview.jsx',
+    },
+    NODE_ENV: 'development',
+    port: 80, // 设置基础端口，如果被占用则自动寻找可用端口
+    assetsPublicPath: '/', // 设置静态资源的引用路径（根域名+路径）
+    assetsSubDirectory: '',
+    hostname: 'localhost',
+    proxyTable: {
+      '/apiTest': {
+        target: 'http://api-test.com.cn', // 不支持跨域的接口根地址
+        ws: true,
+        changeOrigin: true,
+      },
+    },
+    */
+  },
+  linkDebug: {
+    // 用于开启本地调试模式的相关配置信息
+    /*
+    【特别说明】以下配置项都自带默认值，非必填。如需自定义请自行配置。
+    entry: { // 根据 src/components 目录下的文件自动生成 entry 相关配置
+      // 外链调试（在线上页面设计器端预览自定义组件）
+      index: [
+        './src/components/list-widget/register.ts',
+        './src/components/list-widget/model.ts',
+      ],
+    },
+    NODE_ENV: 'development',
+    port: 80, // 设置基础端口，如果被占用则自动寻找可用端口
+    closeHotReload: true, // 是否关闭热更新
+    assetsPublicPath: '/', // 设置静态资源的引用路径（根域名+路径）
+    assetsSubDirectory: '',
+    hostname: 'localhost',
+    proxyTable: {
+      '/apiTest': {
+        target: 'http://api-test.com.cn', // 不支持跨域的接口根地址
+        ws: true,
+        changeOrigin: true,
+      },
+    }
+    */
+  },
+  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/entity-form/model.ts',
+      infoCard: './src/components/entity-form/register.ts'
+    },
+    cssExtract: false, // 不额外提取css文件
+    assetsRoot: resolve('dist') // 上传指定目录下的脚本文件
+    */
+  },
+};

package/src/template/empty-custom-cmp-template/package.json ADDED Viewed

@@ -0,0 +1,57 @@
+{
+  "name": "empty-custom-cmp-template",
+  "version": "1.0.0",
+  "description": "neo 自定义组件",
+  "keywords": [
+    "react&ts 技术栈",
+    "neo 自定义组件"
+  ],
+  "author": "wibetter",
+  "license": "MIT",
+  "scripts": {
+    "preview": "neo preview",
+    "linkDebug": "neo linkDebug",
+    "pushCmp": "neo pushCmp",
+    "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/empty-custom-cmp-template.git"
+  },
+  "bugs": {
+    "url": "https://github.com/wibetter/empty-custom-cmp-template/issues"
+  },
+  "dependencies": {
+    "neo-register": "^1.0.5",
+    "react": "^16.9.0",
+    "react-dom": "^16.9.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^8.3.5",
+    "@commitlint/config-conventional": "^9.1.1",
+    "@types/react": "^16.9.11",
+    "@types/react-dom": "^16.9.15",
+    "neo-cmp-cli": "^1.3.8",
+    "husky": "^4.2.5",
+    "lint-staged": "^10.2.9",
+    "prettier": "^2.0.5"
+  },
+  "engines": {
+    "node": ">= 10.13.0",
+    "npm": ">= 6.4.1"
+  }
+}

package/src/template/empty-custom-cmp-template/public/css/base.css ADDED Viewed

@@ -0,0 +1,283 @@
+@charset "utf-8";
+body {
+  margin: 0;
+  border-width: 0;
+  padding: 0;
+  font-family: PingFangSC-Regular;
+}
+div,
+dl,
+dt,
+dd,
+ul,
+ol,
+li,
+h1,
+h2,
+h3,
+h4,
+h5,
+h6,
+pre,
+code,
+form,
+fieldset,
+legend,
+input,
+textarea,
+p,
+blockquote,
+th,
+td,
+hr,
+i,
+button,
+article,
+aside,
+details,
+figcaption,
+figure,
+footer,
+header,
+hgroup,
+menu,
+nav,
+section {
+  margin: 0;
+  padding: 0;
+  border-width: 0;
+  font-family: PingFangSC-Regular;
+  box-sizing: padding-box;
+  -webkit-box-sizing: padding-box;
+  -moz-box-sizing: padding-box;
+  -webkit-tap-highlight-color: rgba(0, 0, 0, 0);
+}
+body,
+button,
+input,
+select,
+textarea {
+  font-size: 14px;
+  line-height: 1.125;
+}
+[v-cloak] {
+  display: none;
+}
+li,
+ul,
+ol {
+  list-style: none;
+}
+a {
+  text-decoration: none;
+}
+a:active {
+  -webkit-tap-highlight-color: rgba(0, 0, 0, 0);
+}
+sub,
+sup {
+  line-height: 0;
+}
+table {
+  border-collapse: collapse;
+  border-spacing: 0;
+}
+li {
+  list-style: none;
+}
+fieldset,
+img {
+  border: 0;
+}
+input,
+textarea {
+  outline-style: none;
+}
+input[type='text'],
+input[type='search'],
+input[type='password'] {
+  -webkit-border-radius: 0;
+  -moz-border-radius: 0;
+  -o-border-radius: 0;
+  border-radius: 0;
+}
+textarea {
+  resize: none;
+}
+address,
+caption,
+cite,
+code,
+dfn,
+em,
+i,
+th,
+var {
+  font-style: normal;
+  font-weight: normal;
+}
+legend {
+  color: #000;
+}
+abbr,
+acronym {
+  border: 0;
+  font-variant: normal;
+}
+a {
+  text-decoration: none;
+  outline: none;
+}
+a:hover {
+  text-decoration: none;
+}
+.clearit {
+  clear: both;
+  height: 0;
+  font-size: 0;
+  overflow: hidden;
+}
+/* surface下viewport不生效的解决办法 */
+@media screen and (min-width: 767px) and (device-aspect-ratio: 16/9) {
+  @-ms-viewport {
+    zoom: 1;
+    max-zoom: 1;
+    min-zoom: 1;
+  }
+}
+/* surface下IE10 点击链接，背景变色 */
+@media screen and (-ms-high-contrast: active), (-ms-high-contrast: none) {
+  a {
+    background-color: transparent;
+  }
+}
+img {
+  -ms-interpolation-mode: bicubic;
+  image-rendering: optimizeQuality;
+}
+/* portrait：指定输出设备中的页面可见区域高度大于或等于宽度， landscape：横屏*/
+@media not screen and (orientation: landscape),
+  not screen and (orientation: portrait) {
+  body,
+  button,
+  input,
+  select,
+  textarea {
+    font-family: 'Microsoft Yahei', 'Simsun';
+  }
+}
+::-moz-placeholder {
+  color: #767676;
+}
+::-webkit-input-placeholder {
+  color: #767676;
+}
+:-ms-input-placeholder {
+  color: #767676;
+}
+.cont-selected {
+  display: block !important;
+}
+.hidden {
+  visibility: hidden;
+}
+.ellipsis {
+  overflow: hidden;
+  white-space: nowrap;
+  text-overflow: ellipsis;
+}
+.clearfix:after {
+  content: '.';
+  display: block;
+  height: 0;
+  visibility: hidden;
+  clear: both;
+}
+.left {
+  float: left;
+}
+.right {
+  float: right;
+}
+.center {
+  margin: 0 auto;
+}
+.text-center {
+  text-align: center;
+}
+.text-right {
+  text-align: right;
+}
+.text-left {
+  text-align: left;
+}
+.no-border {
+  border: none !important;
+}
+.click-event {
+  cursor: pointer;
+}
+/* 增加iphoneX适配 */
+@media only screen and (device-width: 375px) and (device-height: 812px) and (-webkit-device-pixel-ratio: 3) {
+  .ipx-fixed-bottom {
+    bottom: 34px !important;
+  }
+  .ipx-fixed-top {
+    top: 20px !important;
+  }
+  .ipx-margin-top {
+    margin-top: 20px !important;
+  }
+  .ipx-margin-bottom {
+    margin-bottom: 20px !important;
+  }
+  .ipx-height {
+    height: 34px !important;
+  }
+}
+/* 业务级公用代码 */