2- 自定义配置项目搭建规范(eslint+editorconfig+git Husky+prettier配置)

pack.json中script下的脚本命令都会执行nodemoudle下的.bin中的 命令

主要配置以下规范:

1,.editorconfig配置文件   用于写代码过程中的格式化

.editorConfig有助于为不同DE编辑器上处理同一项目的多个开发人员维护一致的编码风格。多人开发保持一致的编码风格,比如不同设备enter键的作用不一致,配置为一致的,如tab缩进的空格数配置为一致。(一般由项目组长配置,放入放库,成员拉下来时起到规范作用)编译器会自动读取文件,不管编译器自身配置,优先执行该配置文件的配置。注意vscode默认不会自动读取,需要安装扩展EditorConfig for VS Code(Ws不需要)。

在文件根目录下添加.editorConfig配置文件

 2,.prettier配置(vscode的扩展只会对当前编译器有效),想要统一美化格式要配置。用于代码写完的格式化

       ① npm i prettier -D

       ② 在根目录下创建.prettier配置文件,该文件会在运行时自动编译

         ③.prettierignore配置文件 文件根目录下创建  prettier的忽视文件

        

         ④:vscode安装Prettier - Code formatter 这个扩展才能生效

        ⑤:在pack.json中配置脚本,"prettier":"prettier --weiting .",可以进行全局格式化 npm run prettier

        

3,.eslintrc.js配置文件   vscode安装ESLint扩展

extends中配置的为项目中代码要符合的规范,但是和perttier的配置是冲突的

解决方法安装插件解决冲突:npm install eslint-plugin-prettier eslint-config-prettier -D(自定义配置时会默认安装) 这一步不用操作

4,git Husky和eslint

虽然我们已经要求项目使用eslint了,但是不能保证组员提交代码之前都将eslint中的问题解决掉了;
也就是我们希望保证代码仓库中的代码都是符合eslint规范的;那么我们需要在组员执行git commit命令的时候对其进行校验,如果不符合eslint规范,那么自动通过规范进行修复;那么如何做到这一点呢?可以通过Hu5ky工具:
husky是一个git hook.工具,可以帮助我们触发git提交的各个阶段:1,pre-commit(commit前的回调)、commit-msg(commit -m""备注信息的拦截验证)、pre-push(push前的 拦截)

①,配置:npx husky-init :  npm install  安装完会生成一个文件夹,pack.json中会多出一行脚本命令(会自动执行) ;在husky的文件中配置,会执行每次提交都要执行一次eslint规范

 ②,Commitizen:是一个帮我本但是如果每次手动来编写这些是比较麻倾的事情,我们可以使用一个工具:Commitizen是一个帮助我们编写规范commit message的工具;

配置好之后就不需要git commit -m提交了   只需要运行npx cz选择配置项提交

如:

 ③,代码提交验证npm i @commitlint/config-conventional @commitlint/cli -D 

 配置好之后git commit提交就会出错,要用npm cz这种格式化规范提交才行,但是npm cz一般人不容易理解,可以在pack.json的script节点下添加:"commit": "cz",每次通过npm run commit提交

5,vue.config.js 

可以参考vuecli文档,

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值