基于最新 vue3+TypeScript 的 CMS 后端
| 目录 | 作用 |
|---|---|
| assets | 项目资源文件，包括 css、img |
| components | 抽取的组件 |
| pages | 所有项目相关页面 |
| home: 首页 | |
| login: 登录页面 | |
| router | 路由文件 |
| service | 对 axiso 进行过二次封装的网络请求文件 |
| store | Vuex 文件，集中存放数据文件 |
| .env | 环境变量，会被自动注入，主要配置三个环境中的 BASR_URL |
| .env.development | 开发环境 |
| .env.production | 生产环境 |
| .env.test | 测试环境 |
- 系统总览
- 用户管理
- 权限管理
- 角色管理
- 商品管理
效果图
注意点：
- 建议在项目中创建 .env.development | .env.production | .env.test 三个环境文件，配置不同环境主机地址，运行时会自动捕获
下载项目文件
git clone https://github.com/coderx-waper/vue-ts-cms.git安装项目依赖
npm install运行项目
npm run serve or yarn serve
项目会自动在浏览器中打来
http://localhost:8080/EditorConfig 有助于为不同 IDE 编辑器上处理同一项目的多个开发人员维护一致的编码风格。
# http://editorconfig.org
root = true
[*] # 表示所有文件适用
charset = utf-8 # 设置文件字符集为 utf-8
indent_style = space # 缩进风格（tab | space）
indent_size = 2 # 缩进大小
end_of_line = lf # 控制换行类型(lf | cr | crlf)
trim_trailing_whitespace = true # 去除行首的任意空白字符
insert_final_newline = true # 始终在文件末尾插入一个新行
[*.md] # 表示仅 md 文件适用以下规则
max_line_length = off
trim_trailing_whitespace = falseVSCode 需要安装一个插件：EditorConfig for VS Code
Prettier 是一款强大的代码格式化工具，支持 JavaScript、TypeScript、CSS、SCSS、Less、JSX、Angular、Vue、GraphQL、JSON、Markdown 等语言，基本上前端能用到的文件格式它都可以搞定，是当下最流行的代码格式化工具。
1.安装 prettier
npm install prettier -D2.配置.prettierrc 文件：
- useTabs：使用 tab 缩进还是空格缩进，选择 false；
- tabWidth：tab 是空格的情况下，是几个空格，选择 2 个；
- printWidth：当行字符的长度，推荐 80，也有人喜欢 100 或者 120；
- singleQuote：使用单引号还是双引号，选择 true，使用单引号；
- trailingComma：在多行输入的尾逗号是否添加，设置为
none； - semi：语句末尾是否要加分号，默认值 true，选择 false 表示不加；
{
"useTabs": false,
"tabWidth": 2,
"printWidth": 80,
"singleQuote": true,
"trailingComma": "none",
"semi": false
}3.创建.prettierignore 忽略文件
/dist/*
.local
.output.js
/node_modules/**
**/*.svg
**/*.sh
/public/*
4.VSCode 需要安装 prettier 的插件
5.测试 prettier 是否生效
- 测试一：在代码中保存代码；
- 测试二：配置一次性修改的命令；
在 package.json 中配置一个 scripts：
"prettier": "prettier --write ."1.在前面创建项目的时候，我们就选择了 ESLint，所以 Vue 会默认帮助我们配置需要的 ESLint 环境。
2.VSCode 需要安装 ESLint 插件：
3.解决 eslint 和 prettier 冲突的问题：
安装插件：（vue 在创建项目时，如果选择 prettier，那么这两个插件会自动安装）
npm i eslint-plugin-prettier eslint-config-prettier -D添加 prettier 插件：
extends: [
"plugin:vue/vue3-essential",
"eslint:recommended",
"@vue/typescript/recommended",
"@vue/prettier",
"@vue/prettier/@typescript-eslint",
'plugin:prettier/recommended'
],虽然我们已经要求项目使用 eslint 了，但是不能保证组员提交代码之前都将 eslint 中的问题解决掉了：
-
也就是我们希望保证代码仓库中的代码都是符合 eslint 规范的；
-
那么我们需要在组员执行
git commit命令的时候对其进行校验，如果不符合 eslint 规范，那么自动通过规范进行修复；
那么如何做到这一点呢？可以通过 Husky 工具：
- husky 是一个 git hook 工具，可以帮助我们触发 git 提交的各个阶段：pre-commit、commit-msg、pre-push
如何使用 husky 呢？
这里我们可以使用自动配置命令：
npx husky-init && npm install这里会做三件事：
1.安装 husky 相关的依赖：
2.在项目目录下创建 .husky 文件夹：
3.在 package.json 中添加一个脚本：
接下来，我们需要去完成一个操作：在进行 commit 时，执行 lint 脚本：
npm run lint这个时候我们执行 git commit 的时候会自动对代码进行 lint 校验。
通常我们的 git commit 会按照统一的风格来提交，这样可以快速定位每次提交的内容，方便之后对版本进行控制。
但是如果每次手动来编写这些是比较麻烦的事情，我们可以使用一个工具：Commitizen
-
Commitizen 是一个帮助我们编写规范 commit message 的工具；
1.安装 Commitizen
npm install commitizen -D2.安装 cz-conventional-changelog，并且初始化 cz-conventional-changelog：
npx commitizen init cz-conventional-changelog --save-dev --save-exact这个命令会帮助我们安装 cz-conventional-changelog：
并且在 package.json 中进行配置：
这个时候我们提交代码需要使用 npx cz：
- 第一步是选择 type，本次更新的类型
| Type | 作用 |
|---|---|
| feat | 新增特性 (feature) |
| fix | 修复 Bug(bug fix) |
| docs | 修改文档 (documentation) |
| style | 代码格式修改(white-space, formatting, missing semi colons, etc) |
| refactor | 代码重构(refactor) |
| perf | 改善性能(A code change that improves performance) |
| test | 测试(when adding missing tests) |
| build | 变更项目构建或外部依赖（例如 scopes: webpack、gulp、npm 等） |
| ci | 更改持续集成软件的配置文件和 package 中的 scripts 命令，例如 scopes: Travis, Circle 等 |
| chore | 变更构建流程或辅助工具(比如更改测试环境) |
| revert | 代码回退 |
- 第二步选择本次修改的范围（作用域）
- 第三步选择提交的信息
- 第四步提交详细的描述信息
- 第五步是否是一次重大的更改
- 第六步是否影响某个 open issue
我们也可以在 scripts 中构建一个命令来执行 cz：
如果我们按照 cz 来规范了提交风格，但是依然有同事通过 git commit 按照不规范的格式提交应该怎么办呢？
-
我们可以通过 commitlint 来限制提交；
1.安装 @commitlint/config-conventional 和 @commitlint/cli
npm i @commitlint/config-conventional @commitlint/cli -D2.在根目录创建 commitlint.config.js 文件，配置 commitlint
module.exports = {
extends: ['@commitlint/config-conventional']
}3.使用 husky 生成 commit-msg 文件，验证提交信息：
npx husky add .husky/commit-msg "npx --no-install commitlint --edit $1"