create-doc-app

create-doc-app 快速创建一个规范的项目脚手架

脚手架特点

• 项目基于vite 构建，开发效率、体验更好（已集成兼容包@vitejs/plugin-legacy）
• 支持项目类型，1-PC后台管理系统，2-H5移动开发，3-自助机触摸屏项目
• 配置有react、vue3项目可供自由选择
• 统一了代码规法、约束，eslint+prettier+huskylint-staged+commitizen，代码规范，提交规范等。
• eslint 规法采用的是eslint-config-alloy标准（腾讯alloy团队开源产品）,alloy eslint一个优点是只做逻辑校验，而代码的格式规范完成由prettier来完成，如想使用分号结尾或者4个空格，可在.prettierrc.js文件中修改。
• 统一集成了windicss（tailwindcss构建升级版） ui 库。更有效率的开发页面。
• axios网络请求通用方法封装，集成CancelToken取消请求，进一步降低请求容错机制。
• 统一封装了svg图标组件，把相关svg文件放入src/aseets/svg文件夹内，重新 yarn dev运行项目， 在页面中通过<svg-icon type="back" color="red" size="220px" /> 即可使用。react和vue版本参数略有差异，请细看组件文档
• 集成sentry错误日志收集
• 提供部分组件通用开发规则

使用方式

使用前需全局执行以下命令

• npm install -g commitizen 解决部分 windows 电脑提交代码时校验不生效问题（macOS 系统可跳过）
• git config --global core.autocrlf false 解决部分 windows 电脑下换行符问题（macOS 系统可跳过）

开始创建项目

npx create-doc-app create my-app

commit规范

示例: `git commit -m "feat(home): 添加导航栏"`

1. type（必须） : commit 的类别，只允许使用下面几个标识：

  - feat : 新功能
  - fix : 修复bug
  - docs : 文档改变
  - style : 代码格式改变
  - refactor : 某个已有功能重构
  - perf : 性能优化
  - test : 增加测试
  - build : 改变了build工具 如 grunt换成了 npm
  - revert : 撤销上一次的 commit
  - chore : 构建过程或辅助工具的变动

2. scope（必须） : 用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。

3. subject（必须） : commit 的简短描述，不超过50个字符。