eslint-config-strawhouse 是一个基于 eslint 实现的前端代码规范检查工具。
本文将会介绍如何使用 eslint-config-strawhouse，以及如何根据自己的需求进行配置。
安装和配置
安装
使用 npm 安装 eslint-config-strawhouse：
npm i eslint-config-strawhouse --save-dev
配置
创建 .eslintrc.js 文件，并导入 eslint-config-strawhouse：
module.exports = {
"extends": ["eslint-config-strawhouse"]
};现在，你已经成功使用了 eslint-config-strawhouse。
你可以在你的项目的根目录下选择一个存放配置文件的目录，比如叫 .eslintrc.d，然后在其中创建一个文件，叫 .eslintrc.json，内容如下：
{
"extends": ["eslint-config-strawhouse"],
"rules": {
"semi": [2, "always"],
"quotes": [2, "double"],
"no-console": 0
}
}这样你就可以根据自己的需求进行配置了。
规则
默认情况下，eslint-config-strawhouse 拥有许多规则，且均为开启状态。这些检查规则包括：
- no-use-before-define
- no-unused-vars
- no-param-reassign
- eqeqeq
- no-plusplus
- comma-style
- newline-per-chained-call
- space-before-blocks
- no-empty-function
- no-floating-decimal
- no-multi-spaces
- no-multi-str
- no-trailing-spaces
- semi
- semi-spacing
- space-infix-ops
- space-unary-ops
- spaced-comment
示例代码
下面是一段包含一些问题的 JavaScript 代码：
-- -------------------- ---- ------- --- - - - - --- - - - -- ----- --- - - - ----- ------ -- ------- --- --------------- - ----------
使用 eslint 对其进行检查：
eslint example.js
输出：
-- -------------------- ---- ------- ---------- --- ----- ---------- ----- ------ --------- ---- --- ----- ----- ----- ----- --- ------------- --- ----- ----- ----- ----- --- ------------- --- ----- ----- ----- ------ --- ------------- --- ----- -------- ----------- -- - ------ ------ --- ----- ------- ----- ------ --- -------------------- ---- ----- ------- ----- ----- --- ----------- --- ----- -------- ----------- -- - ------ ------ --- ----- -------- ----------- -- - ------ ------ --- ----- -------- -------- ----- ---- --------------- --- ----- -------- ------- ------ --- -------------- ---- ----- ----------- ----- ----- ------ --------- -------------- --- ----- -------- ----------- -- - ------ ------ --- ----- ----- --------- ----
如上所述，检查代码时出现了许多错误。
现在，我们可以使用 eslint-config-strawhouse 来解决这些错误：
创建 .eslintrc.js 文件，内容如下：
module.exports = {
"extends": ["eslint-config-strawhouse"]
};再次运行 eslint example.js：
eslint example.js
没有任何错误提示。
结论
本文介绍了如何使用 eslint-config-strawhouse，以及如何进行配置。
eslint-config-strawhouse 提供了许多检查规则，可以帮助我们在编写代码时遵循前端的最佳实践，并且能够使我们编写出更加规范、可读性更高的代码。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/106690