react-ts-custom-cmp-template/README.md

neo自定义组件模板（react&ts技术栈）

### 目录说明
- src: 自定义组件源码；
- src/assets: 存放组件静态资源，比如 css、img等；
- src/components: 存放自定义组件代码，每个自定义组件以自身名称（cmpType 数值）作为目录进行存放；
- src/components/info-card/index.tsx: 自定义组件的内容文件；
- src/components/info-card/model.ts: 自定义组件的模型文件，用于对接页面设计器；
- 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. **发布到对象存储服务中**
> 需要确保 package.json 中的 name 值唯一，version 值不重复。
```bash
$ npm run publish2oss
```

### 配置项说明（neo-cmp-cli）
[请查看neo-cmp-cli](https://github.com/wibetter/neo-cmp-cli)