losetime / frontend-scaffold-vue

前端脚手架 vite + vue3 + ts

关于项目

介绍还没想好，欢迎补充

技术栈

• Vue 3
• Vite
• Typescript
• ant-design-vue
• lodash-es
• axios
• husky
• lint-staged

代码提交规范

为了团队协作，保证代码的一致性，代码提交加入了 pre-commit 钩子来约束,提交前会检查代码规范性，使用 commit-msg 来约束提交信息的格式，commit-msg 格式：

type(scope?): subject

注意：scope 代表影响范围，可以省略，如果有多个范围，可以使用","来分隔

type 类型如下：

• build: 打包代码
• chore: 构建过程或辅助工具的变动
• ci: 修改 CI 配置
• docs: 文档改变
• feat: 新功能
• fix: 修复 bug
• perf: 性能优化
• refactor: 某个已有功能重构
• revert: 撤销上一次的 commit
• style: 代码格式改变
• test: 测试

提交举例：

chore: run tests on travis ci

feat(blog): add comment section

fix(server,blog): send cors headers

参考：

https://github.com/conventional-changelog/commitlint/#what-is-commitlint

关于 LF 和 CRLF 带来的冲突问题

crlf 和 lf 是文本换行的不同方式

crlf: "\r\n", windows 系统的换行方式

lf: "\n", Linux 和 MAC OS 系统的换行方式

在你使用 git 拉取代码的时候，git 会自动将代码当中与你当前系统不同的换行方式转化成你当前系统的换行方式，从而造成这种冲突

为了统一换行格式，基于当前业界标准，以 lf 为准，所以如果你当前使用的时 windows 系统，请在拉取项目之前，关闭 git 的自动转换，执行以下命令：

git config --global core.autocrlf false

包管理工具

请一致使用 pnpm 作为包管理工具 https://www.pnpm.cn/

更新依赖

全局安装 npm-check

npm install -g npm-check

更新全部依赖

npm-check

手动选择更新

npm-check -u

功能示例

导出示例

export function apiExportDataAnalysis(): Promise<any> {
  return $http.request({
    url: Api.exportDataAnalysis,
    method: 'GET',
    responseType: 'blob',
  })
}

上传示例

export function apiImportStaffSetting(params: IImportStaffSetting, file: File): Promise<any> {
  return $http.uploadFiles(
    {
      url: Api.importStaffSetting,
      method: 'POST',
      params,
    },
    {
      file: file,
    },
  )
}

视频播放库

官网地址：https://github.surmon.me/videojs-player

github地址：https://github.com/surmon-china/videojs-player