阅读 2800
使用这些配置规范并格式化你的代码

使用这些配置规范并格式化你的代码

本文已参与「掘力星计划」,赢取创作大礼包,挑战创作激励金。

热河.png

使用这些配置规范并格式化你的代码

在日常工作中,我们会接触形形色色的工程。如果工程使用的技术架构不同,可能会有对应不同的代码规范。而每个人的编码习惯是不一样的也是难以短时间内改变的,这也是我们常常在开发一个新工程的时候,会遇到各种规范报错的原因。

此时,如果能有一套配置,能够让我们在写代码时不用考虑该工程的规则,只要在保存时就能够自动按照当前工程配置好的规则修复所有错误,这无疑会大大增加我们的开发体验和效率。

下面我将详细讲解为了实现这一目标,我们需要做什么,以及各种规范的基本配置。

EditorConfig

首先,我们需要一个基本的规范,例如缩进,如何换行等等。它要适用于所有的团队,适用于所有的语言,适用于所有的编辑器。

editorconfig 能帮助我们实现这一点。它让所有的开发者在基本编码规范上保持一致。

我们需要做的是:

  1. 安装 EditorConfig 插件(有些编辑器默认支持 EditorConfig ,具体请看 这些编辑器不需要安装插件)。
  2. 配置 .editorconfig 文件。

以下是 .editorconfig 的用法和例子:

## 打开文件时,EditorConfig 插件会在打开的文件的目录和每个父目录中查找名为 .editorconfig 的文件。 
## 如果到达根文件路径或找到具有 root=true 的 EditorConfig 文件,将停止对 .editorconfig 文件的搜索。
## 如果 root=true 没有配置, EditorConfig 插件将会在工程之外寻找 .editorconfig 文件
root = true

## 使用规则匹配文件
## *            匹配任何字符串,路径分隔符 (/) 除外
## **           匹配任意字符串
## ?            匹配任何单个字符
## [name]       匹配给定的字符串中的任何单个字符
## [!name]      匹配不在给定字符串中的任何单个字符
## {s1,s2,s3}   匹配任意给定的字符串
## {num1..num2} 匹配num1和num2之间的任何整数,其中num1和num2可以是正数或负数
## 如规则[*.{js}]只对 .js 文件生效。一般来说,我们配置 [*] 对所有文件生效。
[*]

## 缩进方式。 值可以是 tab 或者 space
indent_style = space

## 缩进大小。当设置为 tab 时,会取 tab_width 的值。
indent_size = 2

## 通常不需要设置。当 indent_size = tab 时,才会生效。
tab_width = 2;

## 设置为 lf、cr 或 crlf 以控制如何表示换行符。
end_of_line = lf

## 设置为 latin1、utf-8、utf-8-bom、utf-16be 或 utf-16le 来控制字符集。
charset = utf-8

## 设置为 true 以删除换行符之前的任何空格字符,设置为 false 以确保不会。
trim_trailing_whitespace = true

## 设置为 true 以确保文件在保存时以换行符结束,设置为 false 以确保不以换行符结束。
inset_final_newline = true

复制代码

Eslint

对于前端开发工程师来说,JavaScript 无疑是我们最好的伙伴了。而 ESLint,它是一款插件化的 JavaScript 代码静态检查工具,其核心是通过对代码解析得到的 AST(Abstract Syntax Tree,抽象语法树)进行模式匹配,定位不符合约定规范的代码。

社区里有很多不同版本的规范,每个团队也可能会制定自己的规范。编码风格千千万,而工程的配置就一套,在多人协作时就必然会出现规范报错的情况。我们需要配置一套规则,让我们不需要 Care 规则到底是什么,在保存文件的时候,自动按照工程规范格式化代码。

怎么办呢?

Eslint 提供了风格指南规则,并明确表示了哪些是可修复的:Stylistic Issues

我们需要做的是:

  1. 本地安装 Eslint 和社区推荐的规范 eslint-config-airbnb (也可以是别的规范)。插件会使用安装的 Eslint 库(如果你还未安装:npm i eslint eslint-config-airbnb)。
  2. VSCode 安装 Eslint插件
  3. 添加 .eslintrc.js 配置文件。
  4. 更改 VSCode 的 setting.json 文件的配置。

其中,想要实现自动按照工程的规则格式化,第四步必不可少。

setting.json

如果你已经安装好了 Eslint插件,按 cmd + shif + p,打开 defaultSettings.json 文件,按 cmd + f 搜索 eslint 可以看到所有 ESlint 在 VSCode 内的默认配置。我们需要对它做一些修改。

还是按 cmd + shift + p 打开 settings.json 文件。这个文件是用户自定义配置,里面的配置会覆盖 defaultSettings.json 里的同名配置。我们在这个文件里对 ESLint插件 的配置做一些修改,让它达到我们想要的效果。

首先,我们想要 保存时自动格式化,实现这个效果的配置有三种:

  • editor.formatOnSave + eslint.format.enable。前者配置:保存时格式化,后者配置:将 ESlint 规则作为格式化标准
  • eslint.autoFixOnSave
  • editor.codeActionsOnSave

其中,第二种 eslint.autoFixOnSave 已经被废弃。使用它会提示更改为 editor.codeActionsOnSave

而第一种和第三种都可以实现,但是更推荐使用第三种 editor.codeActionsOnSave,它支持更高的可配置性。

使用 editor.codeActionsOnSave 的时候,我们需要禁用其它格式化程序,最好的做法是将 ESlint 设置为格式化程序默认值。并且当我们这么做的时候,我们可以关闭 editor.formatOnSave,否则我们的文件将被修复两次,这是没有必要的。

以下便是我们需要在 setting.json 里新增的配置。(注释的地方是默认配置,无需新增)

// 编辑的时候检测还是保存的时候检测,默认在编辑的时候就检测。 default: onType
// "eslint.run": "onType",

// default: false
// "eslint.format.enable": false,

// default: false
// "editor.formatOnSave": false,

"editor.codeActionsOnSave": {
  "source.fixAll.eslint": true
},
"[vue]": {
  "editor.defaultFormatter": "dbaeumer.vscode-eslint"
},
"[javascript]": {
  "editor.defaultFormatter": "dbaeumer.vscode-eslint"
},

// 始终在VSCode的右下角状态栏显示 ESLint 字样,查看 ESLint 运行状态,确保 ESLint 在正常运行
"eslint.alwaysShowStatus": true,

复制代码

.eslintrc.js

接下来,我们聊聊 .eslintrc.js 文件。这个文件将会规定我们的 ESLint 具体该使用什么规则去规范我们的代码。

我们自己往往不需要去配置这个文件,因为工程一般都会配置好了一套规则。我们只需要使用这套规则去格式化代码就好了。

但是看懂每条规则的意义,对于我们也是很重要的,例如你想自己新建工程。

接下来,我将从 普遍用法Vue项目特殊配置React项目特殊配置 来看下如何配置 .eslintrc.js 文件。

普遍用法

// 启用对 es6 的语法和全局变量的支持
{
  env: {
    es6: true,
  },
}
复制代码
  • 如果我们想让 ESLint 不仅能识别浏览器环境中的语法,其它环境(Node)我们也希望它能识别,这时候我们可以这样配置:
{
  env: {
    browser: true,
    node: true,
  },
}
复制代码
  • 在一些项目中,我们需要特殊的解析器去解析我们的代码,是否是符合规范的。这时候我们可以使用 Parser
{
  parser: 'babel-eslint',
}
复制代码
  • 当访问当前源文件内未定义的变量时,no-undef 规则将发出警告。如果你想在一个源文件里使用全局变量,推荐你在 ESLint 中定义这些全局变量,这样 ESLint 就不会发出警告了。
{
  globals: {
    "__DEV__": true,
    "If": true,
    "For": true,
    "POBrowser": true
  },
}
复制代码
  • ESLint 支持使用第三方插件。在使用插件之前,你必须使用 npm 安装它。在配置文件里配置插件时,可以使用 plugins 关键字来存放插件名字的列表。插件名称可以省略 eslint-plugin- 前缀。
{
  	plugins: ['react-hooks', 'jsx-control-statements'],
}
复制代码
  • ESLint 附带有大量的规则。你可以使用注释或配置文件修改你项目中要使用的规则。要改变一个规则设置,你必须将规则 ID 设置为下列值之一:
    • "off"0 - 关闭规则
    • "warn"1 - 开启规则,使用警告级别的错误:warn (不会导致程序退出)
    • "error"2 - 开启规则,使用错误级别的错误:error (当被触发的时候,程序会退出)
{
    rules: {
        eqeqeq: 'off',
        curly: 'error',
        quotes: ['error', 'double']
    }
}
复制代码
  • 配置定义在插件中的一个规则的时候,你必须使用 插件名/规则ID 的形式。比如:
{
  plugins: ['react-hooks', 'jsx-control-statements'],
  rules: {
    'arrow-parens': 0,
    'react-hooks/rules-of-hooks': 'error',
    'react-hooks/exhaustive-deps': 'warn',
    'jsx-control-statements/jsx-use-if-tag': 0,
    'react/jsx-no-undef': ['error', { 'allowGlobals': true }],
    'no-prototype-builtins': 'off',
  }
}
复制代码
  • ESLint 的配置规则实在太多,如果我们自己一条条规则去配置,这个工作了将会非常大。我们可以直接拿现有的规范来使用
{
  extends: 'zoo/react',
}
复制代码

Vue 特殊配置

由于 Vue 单文件组件的特殊写法,针对 Vue 项目,需要做一些特殊的 ESLint 配置,以达到自动化的效果。

高亮语法支持

安装 Vetur插件

使用 ESLint 而不是 Vetur 做代码检测

Vetur 为 Vue 项目带来了语法高亮和便捷的操作。但是它本身也会自动开启对 Vue 文件的代码检测。这往往会和我们配置的 ESLint 有冲突。为了避免这一点,需要在 VSCode 的 settings.json 中做一些配置:

// 不允许它格式化代码
"vetur.format.enable": false,
// 不允许它做代码检测
"vetur.validation.template": false,
"vetur.validation.script": false,
"vetur.validation.style": false,
复制代码

无需将 vue 添加进 eslint.validate,因为 eslint.probe 默认会检测 vue 类型文件。

然后,我们需要配置 .eslintrc.js 文件,里面用到的插件都需要本地安装。

module.exports = {
    root: true,
    // 如果是SSR项目,则需要配置node:true
    env: {
        browser: true,
        node: true,
    },
    // 为什么是这样的parser配置?https://eslint.vuejs.org/user-guide/#how-to-use-a-custom-parser
    parser: 'vue-eslint-parser',
    parserOptions: {
        parser: 'babel-eslint',
    },
    extends: [
        // 如果是nuxt.js的脚手架项目,则需要安装对应的插件并做以下配置
        '@nuxtjs',
        'plugin:nuxt/recommended',

        // 让eslint可以规范vue文件
        'plugin:vue/base',
        // vue3的项目需要使用,如果是vue2项目,使用 plugin:vue/recommended
        'plugin:vue/vue3-recommended',
    ],
    plugins: [
        // 注意这里不能配置 html 选项,为什么?https://eslint.vuejs.org/user-guide/#why-doesn-t-it-work-on-vue-files
        'vue',
    ],
    // 配置自己的规则,覆盖上面继承的规则
    rules: {
        // 配置js的缩进为 2,switch case 语句的 case 也使用2个空格缩进
        indent: ['error', 2, { SwitchCase: 1 }],
        // 使用 eslint 检测 template里的代码,这里我配置 2 个空格缩进
        'vue/html-indent': ['error', 2],
    },
};
复制代码

以上配置,大家根据自己的项目特点,自行删减即可。比如,如果你的项目不是 nuxt.js 的,可以去掉 extends 里的 '@nuxtjsplugin:nuxt/recommended

如果是 Vue cli 创建的项目,并且没有使用 ts,需要在项目根目录添加 jsconfig.json 文件。有关 jsconfig 的配置在这里:jsconfig

React 特殊配置

React 项目中,因为是 .js 文件,一般不需要特殊的配置。但即使如此,针对 JSX 和 Hooks 的使用规则,我们仍然需要做一些事情

针对 React Hooks

lint 规则具体强制了哪些内容?

eslint-plugin-hooksReact 源码目录 packages 里提供的一个包。它会强制执行 Hooks 规则,它也是 Hooks API 的一部分。

npm i eslint-plugin-reack-hooks
复制代码

.eslintrc.js

module.exports = {
  // eslint-plugin 可以简写
  plugins: ['react-hooks'],
}
复制代码
针对 JSX

JSX 不过只是 React 的一个语法糖,其最终都会被 React 调用 React.createElement 编译城 React Element 形式。所以在 17 版本之前,如果我们使用到了 JSX 但是没有引入 React ,会提示 'React' must be in scope when using JSX。 而在 17 版本之后, React 与 babel 和 TypeScript 编译器合作,将转化任务交给了编译器自动转化。

如果我们是之前的转化版本,我们要获得对 JSX 的语法支持,我们需要安装 eslint-plugin-react,它内置了对 JSX 的代码规范检测。

{
  extends: ['plugin:react/recommended'],
}
复制代码

如果不想使用内置的规则,我们也可以自定义规则

{
  plugins: ['react'],
  parserOptions: {
    ecmaFeatures: {
      jsx: true,
    },
  },
  rules: {
    'react/jsx-no-undef': ['error', { "allowGlobals": true }],
  },
}
复制代码

如果是新的转化版本,则需要做一点小小的更改,以便在使用 JSX 的时候,不会要求我们引入 React

{
  extends: ['plugin:react/recommended', 'plugin:react/jsx-runtime'],
}
复制代码

StyleLint

在完成了以上的配置之后,我们已经可以对 .js 文件、.vue 文件的 templatescript 模块实现代码规范和保存时自动格式化了。但是对于 .css、.less、.scss 文件和 .vue 文件的 style 模块,我们还需要做额外的配置,否则样式部分不规范,我们也是没法检测并自动修复的。

我们需要做的是:

  1. npm i stylelint stylelint-config-standard stylelint-scss
  2. 安装 Stylelint插件
  3. 配置 .stylelintrc 文件。
  4. 配置 VSCode 的 setting.json 文件。

其中,第四步也是必须的,我们需要做如下配置:

// 防止编辑器内置的 [css] [less] [scss] 校验和此扩展 [stylelint] 报告相同的错误
"css.validate": false,
"less.validate": false,
"scss.validate": false,

// 保存时使用 eslint 和 stylelint 进行修复
"editor.codeActionsOnSave": {
  "source.fixAll.eslint": true,
  "source.fixAll.stylelint": true
},
// 默认会对很多文件进行检测,这是不必要的,我们只让他检测样式
"stylelint.validate": [
		"css",
		"html",
		"less",
		"postcss",
		"sass",
		"scss",
		"source.css.styled",
		"styled-css",
	],
复制代码

以上,我们的目标已经达成啦!

Prettier

代码格式化工具。很多同学都接触过这个工具,我个人深入了解了一下这个工具,以下是我的个人见解。先看下 Prettier 官方的一段话吧。

So why choose the “Prettier style guide” over any other random style guide? Because Prettier is the only “style guide” that is fully automatic. Even if Prettier does not format all code 100% the way you’d like, it’s worth the “sacrifice” given the unique benefits of Prettier, don’t you think?

可以看到,这个工具旨在让不同公司不同团队不需要考虑代码规范,实现自动化保存格式化。牺牲掉个性化内容。

但是往往不同的团队对规则的使用是不一致的,如果强制所有文件都使用 prettier 自动格式化,会出现与公司配置的代码规范检查工具(例如 ESLint) 冲突的情况。实际表现为自动保存之后,依然出现 ESLint 格式报错。

想让 prettier 生效,需要我们在 VSCode 里配置:

// 所有文件都使用 prettier 格式化
"editor.defaultFormatter": "esbenp.prettier-vscode",

// 只对 js 文件使用 prettier
"[javascript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
 }

// 所有文件都不指定自动格式化方式
"editor.defaultFormatter": null,

// js文件不指定自动格式化方式
"[javascript]": {
    "editor.defaultFormatter": null
 }
复制代码

可以使用 .prettierrc 文件、VSCode 的 setting.json.editorConfig 来配置 prettier

推荐不常使用的文件类型,使用 prettier 去格式化。js,json,jsx,html,css,less,vue 等这些文件,使用工程统一的规范去格式化。

所以,我觉得完全可以卸载它。不知道你怎么看呢?

以上就是全部内容了,希望对你有所帮助~

推荐阅读

电商最小存货 - SKU 和 算法实现

你需要知道的项目管理知识

浏览器渲染之回流重绘

防抖节流场景及应用

开源作品

  • 政采云前端小报

开源地址 www.zoo.team/openweekly/ (小报官网首页有微信交流群)

  • skuDemo

开源地址 github.com/zcy-inc/sku…

招贤纳士

政采云前端团队(ZooTeam),一个年轻富有激情和创造力的前端团队,隶属于政采云产品研发部,Base 在风景如画的杭州。团队现有 50 余个前端小伙伴,平均年龄 27 岁,近 3 成是全栈工程师,妥妥的青年风暴团。成员构成既有来自于阿里、网易的“老”兵,也有浙大、中科大、杭电等校的应届新人。团队在日常的业务对接之外,还在物料体系、工程平台、搭建平台、性能体验、云端应用、数据分析及可视化等方向进行技术探索和实战,推动并落地了一系列的内部技术产品,持续探索前端技术体系的新边界。

如果你想改变一直被事折腾,希望开始能折腾事;如果你想改变一直被告诫需要多些想法,却无从破局;如果你想改变你有能力去做成那个结果,却不需要你;如果你想改变你想做成的事需要一个团队去支撑,但没你带人的位置;如果你想改变既定的节奏,将会是“5 年工作时间 3 年工作经验”;如果你想改变本来悟性不错,但总是有那一层窗户纸的模糊… 如果你相信相信的力量,相信平凡人能成就非凡事,相信能遇到更好的自己。如果你希望参与到随着业务腾飞的过程,亲手推动一个有着深入的业务理解、完善的技术体系、技术创造价值、影响力外溢的前端团队的成长历程,我觉得我们该聊聊。任何时间,等着你写点什么,发给 ZooTeam@cai-inc.com