How to configure VSCode in a standardized way? How to format code?

VSCodeHow to perform standard configuration? How to format code? The following article will introduce you to the basic configuration of various specifications, and talk about how to use these configuration specifications and format your code. I hope it will be helpful to everyone!

Use these configuration specifications and format your code

In our daily work, we come into contact with all kinds of projects. If the technical architecture used by the project is different, there may be corresponding different code specifications. Everyone's coding habits are different and difficult to change in a short time. This is why we often encounter various standard errors when developing a new project. [Recommended study: "vscode tutorial"]

At this time, if there is a set of configurations, we can write the code without considering the rules of the project, as long as we save it Automatically fix all errors according to the rules configured in the current project, which will undoubtedly greatly increase our development experience and efficiency.

Below I will explain in detail what we need to do in order to achieve this goal, as well as the basic configuration of various specifications.

EditorConfig

First, we need a basic specification, such as indentation, how to wrap lines, etc. It needs to work for all teams, for all languages, and for all editors.

editorconfigcan help us achieve this. It keeps all developers aligned on basic coding conventions.

What we need to do is:

• Install theEditorConfigplug-in (some editors supportEditorConfig# by default ##, please seeThese editors do not require the installation of plug-ins).

• Configuration

  .editorconfigfile.

.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

Stylistic Issues

What we need to do is:

• Install Eslint locally and the specifications recommended by the community

  eslint-config-airbnb(can also be other specifications). The plugin will use the installed Eslint library (if you haven't installed it yet:npm i eslint eslint-config-airbnb).

• VSCode Install

  Eslint plug-in.

• Add

  .eslintrc.jsconfiguration file.

• Change the configuration of VSCode’s

  setting.jsonfile.

setting.json

Eslint plugin, presscmd shif p, open thedefaultSettings.jsonfile, presscmd fand searcheslintto see all the default configurations of ESlint in VSCode. We need to make some modifications to it.

cmd shift pto open thesettings.jsonfile. This file is a user-defined configuration, and the configuration inside will overwrite the configuration with the same name indefaultSettings.json. We make some modifications to the configuration ofESLint plug-inin this file to achieve the effect we want.

automatically formatwhen saving. There are three configurations to achieve this effect:

• 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文件。

普遍用法

• 默认情况下，ESLint 支持 ES5 的语法。我们可以覆盖这个配置，启用对 ES6、 ES7 ... 的支持。

// 启用对 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里的'@nuxtjs和plugin:nuxt/recommended。

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

React特殊配置

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

针对 React Hooks

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

eslint-plugin-hooks是React源码目录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文件的template和script模块实现代码规范和保存时自动格式化了。但是对于.css、.less、.scss文件和.vue文件的style模块，我们还需要做额外的配置，否则样式部分不规范，我们也是没法检测并自动修复的。

我们需要做的是：

• npm i stylelint stylelint-config-standard stylelint-scss。

• 安装Stylelint插件。

• 配置.stylelintrc文件。

• 配置 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等这些文件，使用工程统一的规范去格式化。

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

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

更多编程相关知识，请访问：编程入门！！

The above is the detailed content of How to configure VSCode in a standardized way? How to format code?. For more information, please follow other related articles on the PHP Chinese website!