前往小程序,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 删除。

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

评论
登录后参与评论
暂无评论
推荐阅读
编辑精选文章
换一批
左手用R右手Python系列13——字符串处理与正则表达式
学习数据分析,掌握一些灵巧的分析工具可以使得数据清洗效率事半功倍,比如在处理非结构化的文本数据时,如果能够了解一下简单的正则表达式,那么你可以免去大量的冗余代码,效率那叫一个高。 正则表达式是一套微型的袖珍语言,非常强大,依靠一些特定的字母和符号作为匹配模式,灵活组合,可以匹配出任何我们需要的的文本信息。 而且它不依赖任何软件平台,没有属于自己的GUI,就像是流动的水一样,可以支持绝大多数主流编程语言。 今天这一篇只给大家简单介绍正则表达式基础,涉及到一些常用的字符及符合含义,以及其在R语言和Python
数据小磨坊
2018/04/11
1.7K0
左手用R右手Python系列13——字符串处理与正则表达式
文本挖掘|你好,正则表达式!
文本信息: “Ta说群众笑脸smile是最好的扶贫成绩单1234”,按照以往的思路是知道英文字符在文本中的起始位置与终止位置,再根据位置提取出来。当数据量小的时候,这种思路操作是没什么毛病的,但是,当数据量大时,显然这种方法又土又麻烦。
黑妹的小屋
2020/08/05
7230
文本挖掘|你好,正则表达式!
R语言︱文本(字符串)处理与正则表达式
处理文本是每一种计算机语言都应该具备的功能,但不是每一种语言都侧重于处理文本。R语言是统计的语言,处理文本不是它的强项,perl语言这方面的功能比R不知要强多少倍。幸运的是R语言的可扩展能力很强,DNA/RNA/AA等生物序列现在已经可以使用R来处理。
悟乙己
2019/05/26
4.3K0
R语言:通过jiebaR提升正则匹配效率
大家会不会经常遇到这样的情况,需要在一系列的目标文本中,匹配搜索一系列特征文本,且这些特征文本可能在该某一目标文本中重复出现。例如如下数据集:
用户7652506
2022/01/07
4530
【Python之正则表达式与JSON】
在当今快速发展的技术领域,Python已经成为了许多开发者首选的编程语言之一。其简洁而强大的语法使其在各种领域都有着广泛的应用。本篇博客将引领你深入了解Python中正则表达式与JSON的强大组合,揭示它们如何协同工作,为开发者提供了解析和处理文本数据的高效方式。
老虎也淘气
2024/01/30
3510
C++正则表达式攻略:从基础到高级应用
正则表达式是一种用于匹配、搜索和编辑文本的字符串模式。它由一系列字符和特殊符号构成,可以灵活地表达文本的模式、结构和特征。正则表达式在各种编程语言和应用程序中广泛应用,包括C++。它可以用来在文本中查找特定模式的字符串、验证输入的格式、提取信息和进行文本替换等操作。
Lion Long
2025/01/19
1740
C++正则表达式攻略:从基础到高级应用
正则表达式的详解带你认识正则表达式的意义
​ 我们都知道协议通常通过添加固定的字符、报头、特定的数字等来定义数据的结构和格式。将正确的信息提取出来是十分重要的,而正则表达式可以用来描述和匹配这些固定的结构,从而提取出所需的信息。并且正则表达式还可以处理大量复杂的字符串。这篇文章将会带你彻底了解正则表达式。
薄荷冰
2024/06/09
6570
数据科学系列:数据处理(7)--字符串函数基于R(三)
这一部分,将R语言stringr包中的使用正则表达式的字符串函数简单介绍一下,会用到正则表达式的相关内容,有关正则表达式的知识可以回顾R&Python Data Science系列:数据处理(6)--字符串函数基于R(二)
1480
2019/11/21
9430
深入理解Python正则表达式:解析、匹配和高级技巧
正则表达式是一种强大的文本处理工具,它允许你在文本中搜索、匹配和处理模式。Python中的re模块提供了对正则表达式的支持,本文将深入探讨Python正则表达式的工作原理、基本用法、高级技巧以及实际应用,帮助你更好地掌握这一强大的工具。
海拥
2023/09/19
2.5K0
深入理解Python正则表达式:解析、匹配和高级技巧
正则表达式:理解与运用
正则表达式,也称为正则表达式或简称正则,是一种强大的文本处理工具。它可以在文本中查找、替换和提取符合特定模式的文本。本文将解释正则表达式的概念、用法和常见参数。
为了伟大的房产事业
2024/03/15
4080
Python 正则表达式优化与解析
在互联网时代,信息爆炸的背景下,如何快速高效地处理和解析大量的文本数据成为了互联网专家必备的技能之一。Python 作为一门强大的编程语言,提供了丰富的正则表达式(Regular Expression)功能,可以帮助我们在文本处理方面事半功倍。本文将介绍如何在 Python 中进行正则表达式优化和解析,以提升互联网专家的效率。
疯狂的KK
2023/08/06
2930
Python 正则表达式优化与解析
正则表达式(一)
该文介绍了如何利用正则表达式进行字符串处理的一些基本应用。包括字符串匹配、分割、替换等。还介绍了String类中自带的一些正则表达式方法,如matches、split、replace等。
codingblock
2017/12/29
5670
正则表达式:(mysql)
SELECT prod_name FROM products WHERE prod_name REGEXP ‘1000’
后端码匠
2019/09/02
1.2K0
正则表达式:(mysql)
精通正则表达式 - 正则表达式实用技巧
        希望匹配连续多行文本,常见的情况是,一个逻辑行(logical line)可以分为许多现实的行,每一行以反斜杠结尾。
用户1148526
2023/10/14
9490
Python从0到100(二十四):正则表达式的应用
正则表达式是一种用于字符串搜索和操作的强大工具,它允许你使用单个字符串来描述、匹配一系列符合某个句法规则的字符串。在编程中,正则表达式被广泛应用于文本处理,如模式搜索、文本替换、字符串验证等。
是Dream呀
2024/05/28
1010
从基础到最佳实践:精通Python正则表达式
Python re模块精通:解锁Regex文本处理能力!从数据提取、用户验证到自动化任务,掌握字符类、量词、锚点等核心概念。更有re.search()、re.sub()等函数,结合IGNORECASE等修饰符,提升数据处理效率,玩转Cloud Native!
云云众生s
2025/03/20
1160
【Python】正则表达式的艺术:轻松驾驭 Python 的re库
本文将会先介绍什么是正则表达式,然后在介绍正则表达式在python中的应用。 下方图片及案例思路来自:正则表达式
Yui_
2024/12/20
1530
【Python】正则表达式的艺术:轻松驾驭 Python 的re库
Linux通配符和正则表达式通配符 区别_linux正则表达式语法
通配符是shell在做PathnameExpansion时用到的。说白了一般只用于文件名匹配,它是由shell解析的,比如find,ls,cp,mv等。
全栈程序员站长
2022/10/02
5.1K0
Linux通配符和正则表达式通配符 区别_linux正则表达式语法
正则表达式
https://blog.csdn.net/CSDN___LYY/article/details/53104136
洋仔聊编程
2019/01/15
8610
Shell 正则表达式
正则表达式是用于描述字符排列和匹配模式的一种语法规则。 它主要用于字符串的模式分割、匹配、查找以及替换操作。
小小工匠
2021/08/16
1.1K0
推荐阅读
相关推荐
左手用R右手Python系列13——字符串处理与正则表达式
更多 >
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档
查看详情【社区公告】 技术创作特训营有奖征文