ESLint 插件推荐：eslint-plugin-node

前言

对于前端工程师来说，代码质量是很重要的一个方面。代码风格、代码规范等都需要被关注。而为了达到这个目的，一个好用的 ESLint 插件是必不可少的。本篇文章将介绍一个优秀的 ESLint 插件：eslint-plugin-node。它是一个针对 Node.js 开发的官方检查器，提供了一些针对 Node.js 代码的规则。

安装

首先，需要全局安装 ESLint。

$ npm install eslint -g

然后，安装 eslint-plugin-node。

$ npm install eslint-plugin-node --save-dev

配置

修改 .eslintrc 配置文件，增加 eslint-plugin-node 插件。

{
  "plugins": [
    "node"
  ],
  "rules": {
    // 规则
  }
}

规则

eslint-plugin-node 提供了大量的规则，下面介绍一些常用的规则。

no-mixed-requires

该规则禁止混合使用不同的 require 语句风格，并要求所有的 require 语句都放在模块的前面。

// bad
const a = require('a'), b = require('b');

// good
const a = require('a');
const b = require('b');

no-process-env

该规则禁止直接使用 process.env，而应该使用全局变量或命令行参数，以增强代码的可移植性。

// bad
const config = process.env.CONFIG;

// good
const config = getConfig();

no-restricted-modules

该规则禁止使用特定的模块，可以增强代码的安全性。

// bad
const fs = require('fs');

// good
const fs = require('graceful-fs');

no-unpublished-bin

该规则禁止使用未发布的 bin 文件。

{
  "rules": {
    "node/no-unpublished-bin": ["error", {
      "ignore": ["myscript", "myscript.cmd", "myscript.ps1", "myscript.js"]
    }]
  }
}

no-unpublished-import

该规则禁止使用未发布的 import 模块。

-- -------------------- ---- -------
-
  -------- -
    ----------------------------- --------- -
      --------------- ------- ----------- ------------
      --------------- --------------
      --------- ------------- -------------
    --
  -
-

no-unpublished-require

该规则禁止使用未发布的 require 模块。

-- -------------------- ---- -------
-
  -------- -
    ------------------------------ --------- -
      --------------- ------- ----------- ------------
      --------------- --------------
      --------- ------------- -------------
    --
  -
-

总结

eslint-plugin-node 是一个非常好用的 ESLint 插件，它提供了很多针对 Node.js 开发的规则，可以让我们更好地书写和维护代码。在 ESLint 配置文件中增加该插件，设置相关的规则，可以让我们在开发中做到更加严谨，提高代码质量。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/648ec97148841e9894d324fd