vue项目创建+eslint+Prettier+git提交规范(commitizen+hooks+husk)
以下是一个简化的解决方案,用于创建一个新的Vue项目,并配置ESLint、Prettier以及Git提交规范。
- 安装Node.js和npm(如果尚未安装)。
全局安装Vue CLI:
npm install -g @vue/cli
创建一个新的Vue项目:
vue create my-project
进入项目目录:
cd my-project
安装ESLint、Prettier和相关插件:
npm install --save-dev eslint eslint-plugin-vue prettier eslint-config-prettier eslint-plugin-prettier
创建
.eslintrc.js
配置文件,并添加以下内容:module.exports = { extends: [ 'plugin:vue/essential', 'eslint:recommended', 'plugin:prettier/recommended' ], rules: { // 自定义规则 } };
创建
.prettierrc
配置文件,并添加以下内容:{ "semi": false, "singleQuote": true // 其他Prettier规则 }
配置ESLint在保存时自动格式化代码。在
package.json
中添加以下脚本:"scripts": { "lint": "eslint --fix --ext .js,.vue src", "serve": "vue-cli-service serve", "build": "vue-cli-service build", "commit": "git-cz" }, "husky": { "hooks": { "commit-msg": "commitlint -E HUSKY_GIT_PARAMS" } }
安装commitlint和commitizen:
npm install --save-dev @commitlint/{config-conventional,cli} commitizen
在项目根目录创建
.commitlintrc.js
:module.exports = { extends: ['@commitlint/config-conventional'] };
创建
commitlint.config.js
:module.exports = { types: [ 'feat', 'fix', 'docs', 'style', 'refactor', 'perf', 'test', 'build', 'ci', 'chore', 'revert' ] };
安装commitizen配置:
commitizen init cz-conventional-changelog --save --save-exact
安装husky并设置git hooks:
npm install husky --save-dev npx husky install
- 现在可以使用
npm run lint
来格式化代码,使用npm run serve
来启动开发服务器,使用npm run build
来构建生产版本,以及使用npm run commit
来提交git commit。
以上步骤为您提供了一个基本的Vue项目,并配置了ESLint、Prettier以及符合Angular提交规范的git hooks。根据项目需求,您可能需要调整.eslintrc.js
和.prettierrc
中的配置,以及commitlint.config.js
中的提交类型规则。
评论已关闭