编写项目之前需要做点啥呢?

简介: 编写项目之前需要做点啥呢?

学习coderwhy老师的vue3课程,项目规范化配置。


当我们编写项目之前,我们需要规范我们的代码,并且规范代码提交管理,所以需要配置这些东西。


集成editorconfig配置


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 = false


VSCode需要安装一个插件:EditorConfig for VS Code


网络异常,图片无法展示
|


使用prettier工具


Prettier 是一款强大的代码格式化工具,支持 JavaScript、TypeScript、CSS、SCSS、Less、JSX、Angular、Vue、GraphQL、JSON、Markdown 等语言,基本上前端能用到的文件格式它都可以搞定,是当下最流行的代码格式化工具。


1.安装prettier


npm install prettier -D


2.配置.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 ."
复制代码


使用ESLint检测


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'
  ],


git Husky和eslint


虽然我们已经要求项目使用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 文件夹:


npx huksy install


网络异常,图片无法展示
|


3.在package.json中添加一个脚本:


网络异常,图片无法展示
|


接下来,我们需要去完成一个操作:在进行commit时,执行lint脚本:


网络异常,图片无法展示
|


这个时候我们执行git commit的时候会自动对代码进行lint校验。


git commit规范


代码提交风格


通常我们的git commit会按照统一的风格来提交,这样可以快速定位每次提交的内容,方便之后对版本进行控制。


网络异常,图片无法展示
|


但是如果每次手动来编写这些是比较麻烦的事情,我们可以使用一个工具:Commitizen


  • Commitizen 是一个帮助我们编写规范 commit message 的工具;


1.安装Commitizen


npm install commitizen -D


2.安装cz-conventional-changelog,并且初始化cz-conventional-changelog:


npx commitizen init cz-conventional-changelog --save-dev --save-exact


这个命令会帮助我们安装cz-conventional-changelog:


网络异常,图片无法展示
|


并且在package.json中进行配置:


网络异常,图片无法展示
|


这个时候我们提交代码需要使用 npx cz,就不要使用git commit -m ""


  • 第一步是选择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 -D


2.在根目录创建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"


如果使用git commit -m ""提交代码,会报错。


网络异常,图片无法展示
|


相关文章
|
7月前
|
缓存 小程序 前端开发
赢麻了!smardaten闷声干大事,竟然用无代码开发了复杂小程序!
赢麻了!smardaten闷声干大事,竟然用无代码开发了复杂小程序!
|
7月前
|
存储 前端开发 C语言
代码写得很牛逼但UI界面却搞得很丑?来,杨工带你!
代码写得很牛逼但UI界面却搞得很丑?来,杨工带你!
107 0
|
9月前
|
消息中间件 算法 安全
开发者最怕遇到的代码报错
作为一名开发者,遇到代码报错是再平常不过的事情了。无论是在编写新代码还是修改现有代码时,都有可能出现各种各样的错误。有些错误可能只是简单的语法错误,而有些错误可能会导致整个程序无法正常运行。另外,结合阅读《实战总结|记一次消息队列堆积的问题排查》这篇文章,作者在工作中遇到的消息队列堆积的问题以及如何解决这一问题的过程,我深刻认识到了在开发过程中遇到问题准确排查的重要性,以及解决问题的策略和方法。那么接下来,就来聊一聊开发者最怕遇到的代码报错,以及如何有效地解决和避免这些问题。
151 2
开发者最怕遇到的代码报错
|
前端开发 程序员
前端项目(练手)+代码封装
前端项目(练手)+代码封装
前端项目(练手)+代码封装
|
开发框架 缓存 监控
测试是否有必要看开发代码?如何能看懂?
测试是否有必要看开发代码?如何能看懂?
|
前端开发 小程序 IDE
「趣学前端」给不懂技术的朋友简单演示,代码是怎么被编写出来的
我身边不乏非程序员的朋友,对我的工作多多少少带点好奇心。突发奇想,准备了一个小功能,简单演示前端日常开发中的代码是怎么被编写出来的。
125 1
|
安全 前端开发 NoSQL
简单编写的JAVA后台
springboot框架基于 shiro mybatis使用,一周时间做了一个简单的,有什么漏洞和不足的地方还望提示。
135 0
简单编写的JAVA后台
|
设计模式 新零售 供应链
一文教会你如何写复杂业务代码
这两天在看零售通商品域的代码。面对零售通如此复杂的业务场景,如何在架构和代码层面进行应对,是一个新课题。针对该命题,我进行了比较细致的思考和研究。结合实际的业务场景,我沉淀了一套“如何写复杂业务代码”的方法论,在此分享给大家。
28373 1
一文教会你如何写复杂业务代码
|
前端开发 Java Spring
项目中发现了一个新的玩意WebAsyncTask
前言 文本已收录至我的GitHub仓库,欢迎Star:github.com/bin39232820… 种一棵树最好的时间是十年前,其次是现在
147 0
|
Web App开发 缓存 前端开发
Web前端单元测试到底要怎么写?看这一篇就够了
随着 Web 应用的复杂程度越来越高,很多公司越来越重视前端单元测试。我们看到的大多数教程都会讲单元测试的重要性、一些有代表性的测试框架 api 怎么使用,但在实际项目中单元测试要怎么下手?测试用例应该包含哪些具体内容呢? 本文从一个真实的应用场景出发,从设计模式、代码结构来分析单元测试应该包含哪些内容,具体测试用例怎么写,希望看到的童鞋都能有所收获。
5387 0