ESLint 插件 vscode-ESLint 取代标准的 VSCode js 格式化工具 —— js-beautify
前言
在前端开发中，代码风格一直是一个非常重要的问题，良好的代码风格可以提高团队合作的效率、避免因为不同代码风格造成的代码冲突等问题。ESLint 作为前端领域中最流行的代码检查工具，可以检查代码的语法错误、不符合规范的代码风格等问题，因此被越来越多的开发者所使用。本文将与大家分享如何使用 ESLint 插件 vscode-ESLint 取代标准的 VSCode js 格式化工具 js-beautify，从而更好地规范我们的代码风格。
- js-beautify 的缺点
JS-beautify 是一个很受欢迎的代码格式化工具，它可以自动缩进、格式化 JS、HTML、CSS 代码，微软的 VSCode 在内置的插件里就自带了这个插件。但是它也有一些问题：
1.1. 依赖安装问题
js-beautify 的安装需要依赖 Python 2.x 或 Python 3.x，对于 Dev 环境来说可能没太大问题，但对于 Ci 环境，你可能需要安装不同的 Python 版本。
1.2. 稳定性问题
js-beautify 的格式化结果与你的编辑器里的配置有着很大的关系，这样就导致很多时候它可能会做出不理想的格式化操作，特别是缩进和换行问题。
1.3. 重复劳动问题
在使用 js-beautify 进行代码格式化时，我们需要手动保存文件并使用快捷键格式化，而且每次都要进行这样的操作，非常的耗时。
- vscode-ESLint 的解决方案
相比于 js-beautify，ESLint 插件 vscode-ESLint 提供了更加高效、稳定、灵活的代码格式化解决方案。
2.1. 依赖安装问题
相比于 js-beautify，ESLint 插件 vscode-ESLint 要简单得多，只需要在项目中安装 ESLint 和 eslint-config-airbnb-base 等依赖即可。
2.2. 稳定性问题
ESLint 插件 vscode-ESLint 告别了 js-beautify 的格式化不理想问题，能够使你在代码开发后搭配 ESLint 插件一同格式化，让你的代码更加美观和规范。
2.3. 自动化和调整问题
ESLint 插件 vscode-ESLint 能够自动格式化代码，而且可以调整规则配置，使其更加适合自己的代码风格。
- 使用示例
下面将用一段代码作为示例，演示如何使用 ESLint 插件 vscode-ESLint 来格式化代码：
-- -------------------- ---- -------
----- ------ - -
----- -------
----- ----------- ----------
---------- -
- ---- ------------------ ---- -------------------- --
- ---- ------------------ ---- ------------------- --
- ---- ------------------- ---- ------------------- --
--
--
--------------------3.1. 安装 eslint 和 eslint-plugin-prettier 等依赖
npm install eslint eslint-plugin-prettier prettier -D
3.2. 在项目中添加 ESLint 配置文件
-- -------------------- ---- -------
-
---------------- -
-------------- ----
--
------ -
---------- -----
------- -----
------ ----
--
---------- ---------------------- -----------------------------
---------- -------------
-------- -
-------------------- -------
-
-3.3. 在 VSCode 中安装 ESLint 插件 vscode-ESLint
打开终端，运行 ext install eslint.vscode-eslint
3.4. 配置 VSCode 的 settings.json
打开VSCode, 加载workspace settings 或者 user settings, 配置如下：
{
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": true
}
}保存完毕后，重新打开以上的代码，可以看到 VSCode 自动格式化了我们的代码，现在的代码格式已经更加规范和美观了：
const config = {
name: 'test',
time: '2022-02-22 22:22:22',
positions: [{ lat: 51.51321245458721, lon: -0.13675741379880145 }, { lat: 51.51319345821006, lon: -0.1367174690375767 }, { lat: 51.512804346661355, lon: -0.1368094301223755 }],
};
console.log(config);总结
本文着重介绍了如何使用 ESLint 插件 vscode-ESLint 取代标准的 VSCode js 格式化工具 js-beautify，以更好地规范我们的代码风格，提高代码的可维护性和稳定性。ESLint 是一个非常强大的工具，我们可以通过配置定制化的规则来适应不同的代码风格和需求，学会并掌握恰当的配置方式可以很大程度上提升我们的开发效率，为今后的职业生涯打下良好的基础。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/659f52f5add4f0e0ff7fc202