@yinta/ui v2.15.85

A UI Toolkit for Web.

Links

Install

Quick Start

node build/bin/new.js yt-hello 按钮

Browser Support

Development

Changelog

FAQ

LICENSE

MIT

规范

除了遵守前端开发规范以外还需注意一下几点:
1. 通常非以上文件说明不要更新
2. 非中文文档不用更新
3. 测试相关不用填写测试用例
4. TS相关不用更新
5. 组件遵守命名规范以yt 开头
6. 框架层面的代码不要私自修改
7. 样式尽量采用BEM风格（不作严格要求，但要看起来像BEM 格式），并且class name 请以yt 开头
8. 原则上不要修改原组件代码，copy 一份代码，新建一个组件（确实需要修改原组件代码请和@张淇@任辉沟通）
9. 项目工程开启了eslint检查，如有代码格式问题，请执行“npm run lint”修复
10. 请记得修改CHANGELOG.zh-CN.md文件来更新日志。

Code Review

新组件必须进行code review，code review完后可以放在某个业务进行深层测试，测试通过可进行发布。

创建组件

在项目根目录直接执行 "node build/bin/new.js yt-hello "命令生成该组件相关的文件

本地运行

1. npm run dev 该命令用于运行组件库的本地开发环境（组件文档）
2. npm run dev:play 该命令用于组件库开发中的功能（demo）展示

发布

基于prod分支发布版本，注意需要发布新版组件库和在线文档，发布权限收敛，如果发布请联系@张淇@任辉

1. npm run deploy:build 该命令作用主要是打包构建项目官网内容，为网站部署做准备。
2. npm run dist 该命令是编译所有组件，为发布做为准备
3. 更新版本

"pub:patch": "npm version patch",
"pub:minor": "npm version minor",
"pub:major": "npm version major",

3. 发布

 "pub": "npm publish --access public"

4. 文档发布：在jekins构建https://newjenkins.yintaerp.com/job/yinta-fe-ui/，在线文档地址https://yinta-fe-ui.erp-sit.yintaerp.com/

5. 发布流程

1 更新版本

手动更新 或者 命令更新

2 打包
yarn dist
yarn deploy:build

3 发布

yarn pub

业务线接入

1. 移除package.json 里面的element-ui 包引用，然后再把node_modules里面的element-ui也一起删除 。
2. package.json 里面添加 "@yinta/ui": "2.15.27"，然后 yarn install ，项目工程注意锁定某个版本号，降低升级风险。
3. 修改vue.config.js文件(不同项目工程可能配置不一样)，重写element-ui 路径。（项目代码中之前引用element-ui 路径都不用改！！！）
4. 如果是以cdn的方式接入，需要把 dist-for-cdn 目录的内容拷贝到 yinta-fe-common 项目中去发布一下得到cdn地址。具体可以参考https://alidocs.dingtalk.com/i/nodes/QOG9lyrgJP3DoQlDHMEEm5LvVzN67Mw4?utm_scene=team_space。

module.exports = {
  ...
  configureWebpack: {
      resolve: {
        alias: {
          'element-ui': '@yinta/ui'
        }
      }
    }  
  ...
}

或

module.exports = {
  ...
   chainWebpack: config => {
    // 添加别名
    config.resolve.alias.set('element-ui', '@yinta/ui')
  }
  ...
}