ESLint 是一个非常流行的 JavaScript 代码检查工具，可以在编码时帮助我们发现代码中的潜在问题，提高代码的可读性和可维护性。@springernature/eslint-config 是 Springer Nature 在 ESLint 基础上进行的一些配置和扩展，可以更好地满足公司的代码规范和最佳实践。本文将介绍如何使用这一 npm 包。
安装
首先需要安装 ESLint 和 @springernature/eslint-config 包：
npm install eslint @springernature/eslint-config --save-dev
配置
接下来需要在项目根目录下创建 .eslintrc.js 文件，并配置 extends 属性：
module.exports = {
extends: ['@springernature']
}这样就可以使用 Springer Nature 的 ESLint 配置了。
配置详解
@springernature/eslint-config 包含了一些常见的、有争议的以及 Springer Nature 特有的规则。下面介绍一些常见的配置项及其含义。
格式化
{
'indent': ['error', 2],
'max-len': ['error', { 'code': 120 }]
}这一段配置指定了缩进和每行最大长度。Springer Nature 使用了 2 个空格作为缩进符号，并将每行最大长度设置为 120。
ES6 和 import/export
-- -------------------- ---- -------
-
--------- ---------------
---------- -
--------
--
-------- -
----------------------------- ------
----------------------- --------
--------------- --------
----------------- --------
------------------- --------
---------------- --------
-------------------------- --------
---------------------------------- -------
-
-这一段配置指定了使用 babel-eslint 库来解析 ES6 代码，并使用了 import 插件对模块加载的语法进行检查。其中 import/no-unresolved 指定了模块是否存在，import/named 则指定了模块中导出的内容是否可以使用。
React
-- -------------------- ---- -------
-
---------- -
-------
--
-------- -
------------------------ ------
----------------------- ------
------------------- -----
-
-这一段配置主要是针对 React 项目，其中 jsx-a11y/href-no-hash 指定了链接地址不能使用 #，react/jsx-sort-props 则指定了组件属性的顺序，React/prop-types 对组件属性的类型进行检查。
示例代码
下面是一段使用 @springernature/eslint-config 的示例代码：
-- -------------------- ---- -------
------ ----- ---- -------
------ --------- ---- ------------
----- ---------- ------- --------------- -
-------- -
------ -
---------- -----------------------
-
-
-
-------------------- - -
----- ----------------
-
------ ------- ----------这里使用了 React 组件，引入了 PropTypes 库进行属性类型检查，并且使用了 import 语法进行模块加载。
结论
@springernature/eslint-config 包含了一些常见的、有争议的以及 Springer Nature 特有的规则，可以很好地满足公司的代码规范和最佳实践。在使用时只需要简单地配置 extends 属性，就可以得到一套适用于自己项目的 ESLint 规则。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/5eedbb16b5cbfe1ea061194a