前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
社区首页 >专栏 >一套标准的前端代码工作流

一套标准的前端代码工作流

作者头像
逆锋起笔
发布于 2021-03-17 01:44:37
发布于 2021-03-17 01:44:37
1.3K00
代码可运行
举报
文章被收录于专栏:逆锋起笔逆锋起笔
运行总次数:0
代码可运行

作者:geekape https://juejin.cn/post/6921223155621036039

工欲善其事,必先利其器。对于写代码而言,也是需要有一套完善的工作流(工具和流程)。

先说下编辑器选择,在踏入前端行业之前,我最喜欢的代码编辑器就是 sublime text ,它很简单,编写大部分语言都很ok,就比如说写 python ,下面是我在2017年我在学习 python 时发布过一篇关于 sublime text 的百度经验:

但是我现在几乎不再使用它,取而代之的是 VSCode,一款微软开源的代码编辑器,它自带 giteslint 等工具,让我们编码更加的有质量,有效率。

接下来是代码规范方面,刚写代码的前几年,我毫不关心代码质量,遵循“能用就行”的原则,随着项目的迭代,代码越来越臃肿(好在我之前项目都不需要迭代),我仿佛听到有人骂骂咧咧的在吐槽我代码?,就像我吐槽别人代码一样。现在我们完全可以使用 eslintprettiereditorConfig 来规范我们的代码,对于团队而言,这个至关重要。

再聊聊 git工作流 ,现在管理代码几乎都是使用 git 版本管理工具,了解它是必要的,像一些基本的推拉合,解决冲突这些我们就不聊了,主要聊下团队协作方面使用 git 的工具及使用方法。

下面我将主要围绕上面三个点来推荐一些工具和使用方法。

ESLint

ESLint 是一款插件化的 JavaScript 代码静态检查工具,其核心是通过对代码解析得到的 AST(Abstract Syntax Tree,抽象语法树)进行模式匹配,来分析代码达到检查代码质量和风格问题的能力。

安装

安装并初始化 eslint:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
// 全局安装
npm install -g eslint

// cd到项目根目录下
// 强制初始化package.json
npm init -force

// 初始化ESLint
eslint --init

使用方式

写注释

下面这行注释表示在当前文件中禁用 console 关键字

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
/* eslint no-console: "error" */
写文件

ESLint支持 eslint.jseslintrc.yamleslintrc.json 类型的配置文件。

如 eslint.js 配置文件:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
module.exports = {
        env: {
                // 环境
                browser: true,
                es2021: true,
        },
        extends: [
                // 拓展
                'eslint:recommended',
                'plugin:@typescript-eslint/recommended',
        ],
        parser: '@typescript-eslint/parser', // 解析器,本解析器支持Ts
        parserOptions: {
                // 解析器配置选项
                ecmaVersion: 12, // 指定es版本
                sourceType: 'module', // 代码支持es6,使用module
        },
        plugins: [
                // 插件
                '@typescript-eslint',
        ],
        rules: {
                // 规则
        },
};

配置项

  • parser - 解析器
  • parserOptions - 解析器选项
  • env 和 globals - 环境和全局变量
  • rules - 规则
    • off或0,关闭规则
    • warn或1,开启规则
    • error或2,开启规则,并会出错阻止代码运行
  • plugins - 插件
  • extends - 拓展

配置优先级

规则是使用离要检测的文件最近的 .eslintrc文件作为最高优先级。

  1. 行内配置
  2. 命令行选项
  3. 项目级配置
  4. IDE环境配置

Prettier

Prettier 是一个代码格式化的工具。

安装使用

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
npm install --save-dev --save-exact prettier

// 格式化所有文件,npx命令是使用当前项目下的prettier
npx prettier --write .

配置文件

Prettier 支持 .prettierrc 为名称,以 .yaml .yml .json .js 为后缀的的配置文件,当然你也可以使用 package.json 文件中的 Prettier 属性来配置。

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
module.exports = {
        printWidth: 80, //一行的字符数,如果超过会进行换行,默认为80
        tabWidth: 2, //一个tab代表几个空格数,默认为80
        useTabs: false, //是否使用tab进行缩进,默认为false,表示用空格进行缩减
        singleQuote: false, //字符串是否使用单引号,默认为false,使用双引号
        semi: true, //行位是否使用分号,默认为true
        trailingComma: 'none', //是否使用尾逗号,有三个可选值"
}

EditorConfig

EditorConfig有助于维护跨多个编辑器和IDE从事同一项目的多个开发人员的一致编码风格,团队必备神器。

.editorconfig文件

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
# EditorConfig is awesome: https://EditorConfig.org

# top-most EditorConfig file 表示是最顶层的配置文件,发现设为true时,才会停止查找.editorconfig文件
root = true

# Unix-style newlines with a newline ending every file 对于所有的文件  始终在文件末尾插入一个新行
[*]
end_of_line = lf
insert_final_newline = true

# Matches multiple files with brace expansion notation
# Set default charset  对于所有的js,py文件,设置文件字符集为utf-8
[*.{js,py}]
charset = utf-8

# 4 space indentation 控制py文件类型的缩进大小
[*.py]
indent_style = space
indent_size = 4

# Tab indentation (no size specified) 设置某中文件的缩进风格为tab Makefile未指明
[Makefile]
indent_style = tab

# Indentation override for all JS under lib directory  设置在lib目录下所有JS的缩进为
[lib/**.js]
indent_style = space
indent_size = 2

# Matches the exact files either package.json or .travis.yml 设置确切文件 package.json/.travis/.yml的缩进类型
[{package.json,.travis.yml}]
indent_style = space
indent_size = 2

通配符

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
*                匹配除/之外的任意字符串
**               匹配任意字符串
?                匹配任意单个字符
[name]           匹配name中的任意一个单一字符
[!name]          匹配不存在name中的任意一个单一字符
{s1,s2,s3}       匹配给定的字符串中的任意一个(用逗号分隔) 
{num1..num2}    匹配num1到num2之间的任意一个整数, 这里的num1和num2可以为正整数也可以为负整数

属性

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
indent_style    设置缩进风格(tab是硬缩进,space为软缩进)
indent_size     用一个整数定义的列数来设置缩进的宽度,如果indent_style为tab,则此属性默认为tab_width
tab_width       用一个整数来设置tab缩进的列数。默认是indent_size
end_of_line     设置换行符,值为lf、cr和crlf
charset         设置编码,值为latin1、utf-8、utf-8-bom、utf-16be和utf-16le,不建议使用utf-8-bom
trim_trailing_whitespace  设为true表示会去除换行行首的任意空白字符。
insert_final_newline      设为true表示使文件以一个空白行结尾
root           表示是最顶层的配置文件,发现设为true时,才会停止查找.editorconfig文件

VSCode集成

我使用的是 VSCode ,来给它添加魔法,加 EditorConfigEslintPrettierGit 扩展。

下面是 Prettier 的扩展,我以下安装好了,大家在扩展中自行搜索安装就好了。微信搜索公众号 逆锋起笔,关注后回复 编程资源,领取各种经典学习资料。

配置全局工作区 setting.json 文件,在文件中加入下面配置:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
// 设置全部语言在保存时自动格式化
"editor.formatOnSave": ture,
// 设置特定语言在保存时自动格式化
"[javascript]": {
    "editor.formatOnSave": true
}

prettier配置

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
{
  // 设置全部语言的默认格式化程序为prettier
  "editor.defaultFormatter": "esbenp.prettier-vscode",
  // 设置特定语言的默认格式化程序为prettier
  "[javascript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  }
}

ESLint配置

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
{
// 保存时自动修复
"editor.codeActionsOnSave": {
    // For ESLint
    "source.fixAll.eslint": true,
}
}

husky/lint-staged

在提交 git 之前,我们需要校验我们的代码是否符合规范,如果不符合,则不允许提交代码。

首先,安装依赖:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
npm install -D husky

// lint-staged 可以让husky只检验git工作区的文件,不会导致你一下出现成百上千个错误
npm install -D lint-staged

然后修改 package.json,增加配置:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
"scripts": {
 "precommit": "eslint src/**/*.js"
}
"husky": {
  "hooks": {
    "pre-commit": "lint-staged"
  }
},
"lint-staged": {
  "src/**/*.{js,vue}": ["prettier --write", "eslint --cache --fix", "git add"]
}

git commit 之前会进入 工作区文件的扫描,执行 prettier 脚本,修改 eslint 问题,然后重要提交到工作区。

Commitizen

一个格式化commit message的工具,为什么需要这个工具,下面是 angular.js 开源项目的commit message,很清楚明了是不是,几乎所有大项目和大公司都在使用这种 commit 规范。

好处:

  • 提供更多的历史信息,方便快速浏览
  • 可以过滤某些commit,便于筛选代码review
  • 可以追踪commit生成更新日志
  • 可以关联issues

安装

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
npm install -g commitizen

安装符合AngularJS规范的提交说明,初始化cz-conventional-changelog适配器:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
commitizen init cz-conventional-changelog --save --save-exact

然后使用 git cz 命令 代替 git comit 来提交git说明:

定制化项目提交说明

上面的提交说明都是英文的,如果想自定义,可以试试cz-customizable,先安装:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
npm install cz-customizable --save-dev

修改package.json文件:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
"config": {
  "commitizen": {
    "path": "node_modules/cz-customizable"
  }
}

在项目根目录下创建 .cz.config.js 文件:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
'use strict';

module.exports = {

  types: [
    {value: '特性',     name: '特性:    一个新的特性'},
    {value: '修复',      name: '修复:    修复一个Bug'},
    {value: '文档',     name: '文档:    变更的只有文档'},
    {value: '格式',    name: '格式:    空格, 分号等格式修复'},
    {value: '重构', name: '重构:    代码重构,注意和特性、修复区分开'},
    {value: '性能',     name: '性能:    提升性能'},
    {value: '测试',     name: '测试:    添加一个测试'},
    {value: '工具',    name: '工具:    开发工具变动(构建、脚手架工具等)'},
    {value: '回滚',   name: '回滚:    代码回退'}
  ],

  scopes: [
    {name: '模块1'},
    {name: '模块2'},
    {name: '模块3'},
    {name: '模块4'}
  ],

  // it needs to match the value for field type. Eg.: 'fix'
  /*
  scopeOverrides: {
    fix: [
      {name: 'merge'},
      {name: 'style'},
      {name: 'e2eTest'},
      {name: 'unitTest'}
    ]
  },
  */
  // override the messages, defaults are as follows
  messages: {
    type: '选择一种你的提交类型:',
    scope: '选择一个scope (可选):',
    // used if allowCustomScopes is true
    customScope: 'Denote the SCOPE of this change:',
    subject: '短说明:\n',
    body: '长说明,使用"|"换行(可选):\n',
    breaking: '非兼容性说明 (可选):\n',
    footer: '关联关闭的issue,例如:#31, #34(可选):\n',
    confirmCommit: '确定提交说明?'
  },

  allowCustomScopes: true,
  allowBreakingChanges: ['特性', '修复'],

  // limit subject length
  subjectLimit: 100

};

然后运行, git cz

Commitizen校验

检验提交的说明是否符合规范,不符合则不可以提交

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
npm install --save-dev @commitlint/cli

// 安装符合Angular风格的校验规则
npm install --save-dev @commitlint/config-conventional 

在根目录下创建 commitlint.config.js 并配置检验:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
module.exports = {
  extends: ['@commitlint/config-conventional']
};

然后在 package.json 中配置 husky ,之前我们已经安装过了,直接添加配置:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
"husky": {
  "hooks": {
    "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
  }  
}

给commit加表情

如这样子的,是不是更加生动形象了,有意思了。

安装:

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
npm i -g gitmoji-cli

使用:你可以在这个 gitmoji 网站找到更多的表情来丰富你的提交记录,只需要在提交记录中加上类型 :bug: 的代码就可以显示表情了。

参考资料

  • https://juejin.cn/post/6909788084666105864
  • https://cloud.tencent.com/developer/article/1546185
  • https://www.jianshu.com/p/d264f88d13a4
  • https://juejin.cn/post/6844903831893966856

推荐阅读

一个无名前端的 10 年前端路

干货!前端 Code Review 的最佳实践方案

25 个实用前端网站工具推荐

这 5 个 Linux 发行版,2021 年再错过就是罪过了

用好这 7 个 VS Code 插件,前端编程效率蹭蹭涨

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
支持下 
本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2021-03-01,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 逆锋起笔 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
暂无评论
推荐阅读
编辑精选文章
换一批
前端实用程序包utils - 开发工作流(一)
早年间有幸在Raychee哥门下当小弟,学到两把刷子。在编程路上,他的很多思想深深影响了我,比如笔者今天要分享的主题。在程序开发中,有个utils包,叫做实用程序包,程序员们会把项目中通用的东西抽离出来放到这个里面,这有利于项目工程化的落地,提高项目的可维护性,减少代码冗余,锻炼编码能力,提高编码效率,理解编程思想。
江涛学编程
2021/05/11
1.4K0
前端实用程序包utils - 开发工作流(一)
前端 QA 工具链指南 - husky,commitlint,commitizen,eslint,typescript,express
https://www.npmjs.com/package/lint-staged
szhshp
2022/08/11
6730
React搭建规范
npx create-react-app react-standard-f –template typescript
赤蓝紫
2023/10/23
2340
React搭建规范
从 0 开始手把手带你搭建一套规范的 Vue3.x 工程化项目
Vue3 跟 Vite 正式版发布有很长一段时间了,生态圈也渐渐丰富起来,作者已在多个项目中使用,总结一下:就是快!也不用担心稳定性问题,开发体验真不是一般好!还没尝试的同学可以从本文开始学习,从 0 开始手把手带你搭建一套基于 Vite + Vue3 + TypeScript 规范的前端工程化项目环境。
XPoet
2021/04/26
6.6K0
从 0 开始手把手带你搭建一套规范的 Vue3.x 工程化项目
前端规范指南,让团队代码如出一辙!ESLint + Prettier + husky + lint-staged
假如团队中的小伙伴在提交代码时没有遵循规范要求,例如只写了一个"修改"或"更新,这会给团队中其他小伙伴造成困扰呢,不得不花时间查看代码和推测逻辑。
程序员王天
2023/10/18
2.8K0
前端规范指南,让团队代码如出一辙!ESLint + Prettier + husky + lint-staged
前端基建处理之组件库优化方案
前端基建开发一直被认为是前端开发中的 “高阶技能”。而内部组件库的开发则算是基建中比较“容易”入手的一个方向。所以咱们今天就利用这篇文章,来看一看 组件库开发 的优化方案。
winty
2024/01/03
4340
前端基建处理之组件库优化方案
巧用 gitHooks 提交前校验代码
在每一个使用 git 进行版本管理的仓库,都有一个目录 .git/hooks,包含 commit 各个阶段 Hooks 的脚本。这些 Hooks 在 git 操作 commit、push、merge 等得时候,可以做前置或者后置的操作,例如 pre-commit 在 git commit 前可以做代码校验,校验代码的时候使用的ESLint,格式化使用的是 prettier。Git 支持的常用钩子见下表,更多请查看官网Hooks:
刘小夕
2021/12/09
4.8K0
巧用 gitHooks 提交前校验代码
让你的git message更加规范
规范比业务开发搬砖更为重要,没有一个好的编码规范,维护老的代码或者是编写新的代码都非常痛苦
w候人兮猗
2020/06/24
3980
【打造前端现代化规范工程】Vite + ESLint + Husky + Commitlint + Lint-staged
本文虽然使用 Vite 创建了一个 Vue3 + TS 的项目,但其实文中涉及的内容和技术栈并没有关系,主要是结合 ESLint ,Husky,等第三方库实现比较规范的现代化前端工程,可应用于任何技术栈的项目中
一尾流莺
2023/04/23
1.3K0
【打造前端现代化规范工程】Vite + ESLint + Husky + Commitlint + Lint-staged
15分钟快速配置eslint,prettier,lint-staged,husky,commitizen实现前端项目代码规范化
当前,前端项目支持代码规范校验、代码格式化已经必不可少,同时需要支持代码提交前对代码格式校验预检查,这里提供一份最简单的配置供大家参考。
蓓蕾心晴
2022/05/09
4.5K2
15分钟快速配置eslint,prettier,lint-staged,husky,commitizen实现前端项目代码规范化
盘点那些前端项目上的规范工具
规范化是前端工程化的一个重要部分。现在,有许多工具能够辅助我们实行代码的规范化,比如你一定知道的 ESLint 和 Prettier。
@超人
2023/05/12
9780
盘点那些前端项目上的规范工具
小程序开发格式化代码ESLint、Prettier、husky、lint-stage
依赖 yarn init yarn add --dev babel-eslint@10.0.3 yarn add --dev eslint@6.7.1 yarn add --dev eslint-config-alloy@3.7.1 yarn add --dev eslint-config-prettier@6.10.0 yarn add --dev eslint-plugin-prettier@3.1.4 yarn add --dev prettier@2.0.5 yarn add --dev prett
kif
2023/02/27
2.5K0
利用 Lint 工具链来保证代码风格和质量
在真实的工程项目中,尤其是多人协作的场景下,代码规范就变得非常重要了,它可以用来统一团队代码风格,避免不同风格的代码混杂到一起难以阅读,有效提高代码质量,甚至可以将一些语法错误在开发阶段提前规避掉。但仅有规范本身不够,我们需要自动化的工具(即Lint 工具)来保证规范的落地,把代码规范检查(包括自动修复)这件事情交给机器完成,开发者只需要专注应用逻辑本身。
江拥羡橙
2023/11/24
5500
利用 Lint 工具链来保证代码风格和质量
在 monorepo 中怎么组织和优化研发流程?
本文是基于Vite+AntDesignVue打造业务组件库[2]专栏第 10 篇文章【在 monorepo 中怎么组织和优化研发流程?】,前面几篇都在说函数库开发的相关内容,所以本文接着围绕这块说,主要是把研发流程梳理清楚,方便后续更多内容的铺开。
程序员白彬
2023/03/02
1.2K0
在 monorepo 中怎么组织和优化研发流程?
前端 QA 工具链指南 - husky,commitlint,commitizen,eslint,typescript,express
https://www.npmjs.com/package/lint-staged
szhshp
2022/09/21
6190
从 0 搭建 Vite 3 + Vue 3 前端工程化项目
Vue 3 正式版已经发布有一段时间了,随着 Vite 脚手架注定成为下一代前端工具链,许多用户都想基于 Vite 来构建 Vue 项目,如果想基于 Vite 构建 Vue 3 项目,社区模板完全满足您的需求,如果想构建 Vite 3 + Vue 3 + JavaScript 项目,那社区模板不太能满足您的需求,因为社区模板提供 Vue 3 项目几乎是基于 Vite 2 + TypeScript 构建,对于不熟悉 TypeScript 语言的用户不是很友好,因此接下来从 0 开始手把手带大家搭建一套规范的 Vite 3 + Vue 3 + JavaScript 前端工程化项目环境。
前端老道
2023/02/27
3.5K0
从 0 搭建 Vite 3 + Vue 3 前端工程化项目
【二】项目规范和项目管理
在这一章我们进行一个简单的项目规范和项目管理,为了更好的代码协同,我们选择使用 Git 对代码进行管理并通过一系列 npm 包配置相应的规范约束。
思索
2024/09/24
1270
【二】项目规范和项目管理
2022年3月最新Eslint + Prettier + Husky + Stylelint + Jest + CI/CD 超详细前端单元测试&规范工程化工作流
由于我的示例项目使用Next.js框架构建,需要在extends中额外配置"next"。 同时个人建议配置react-hooks插件
源心锁
2022/08/12
1.9K0
2022年3月最新Eslint + Prettier + Husky + Stylelint + Jest + CI/CD 超详细前端单元测试&规范工程化工作流
前端工程化之 commitlint + husky 实现 git 提交规范化
对于编程语言进行「语法、书写」校验,能有效「归并」不同开发者的「不同风格」,还能检验出一些语法错误。
小鑫
2022/05/11
3.5K0
NestJS 7.x 折腾记: (1) 项目初始化及常规提交门禁加入
系列常规操作,没兴趣的可以跳过这篇水文. 写过Angular 2+的小伙伴会有一种天然的熟悉感. 因为Nest基本就是同一个思想模式搞得~~
CRPER
2022/03/08
1K0
NestJS 7.x 折腾记: (1) 项目初始化及常规提交门禁加入
推荐阅读
相关推荐
前端实用程序包utils - 开发工作流(一)
更多 >
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档
查看详情【社区公告】 技术创作特训营有奖征文