Jira 人员管理项目开发笔记
项目环境
nodejs v16.16.0
react v18.2.0
typescript v5.1.3
prettier v2.8.8
yarn v1.22.19
编辑器推荐安装插件
- Code Spell Checker:英文拼写校验
- Git Graph:Git 提交记录可视化
- Auto Close Tag:HTML 标签闭合
- Auto Rename Tag:HTML 标签重命名
- Error Lens:错误行内提示
项目开发
1. 项目初始化
运行命令创建 react 项目
npx create-next-app
2. 安装依赖
2.1 prettier
代码格式化工具
# 1. 安装依赖
yarn add --dev --exact prettier
# 2. 格式化项目配置
echo {} > .prettierrc.json
格式化忽略文件
.prettierignore
代码格式化命令
yarn prettier --write .
Git Commit 项目代码格式化流程
# 1. 安装 husky 和 lint-stage,并往 package.json 文件中补充相关配置
npx mrm@2 lint-staged\
# 2. 初始化 husky
npx husky-init
# 3. 安装 pretty-quick 依赖
yarn add --dev pretty-quick
# 4. 配置 git commit 前置 hook
yarn husky set .husky/pre-commit "npx pretty-quick --staged"
2.2 commit-lint
代码提交信息格式校验
git commit -m 'this commit message'×git commit -m 'docs: this commit message'√
# 1. 安装依赖
yarn add @commitlint/config-conventional @commitlint/cli
# 2. 创建配置文件
echo "module.exports = {extends: ['@commitlint/config-conventional']}" > commitlint.config.js
# 3. 补充 hook 信息
npx husky add .husky/commit-msg 'npx --no -- commitlint --edit ${1}'