no-mixed-requires

Disallow require calls to be mixed with regular variable declarations

此规则于 ESLint v7.0.0 中废弃，请使用 eslint-plugin-n 中的对应规则代替。

在 Node.js 社区，人们通常习惯于将调用 require 模块的初始化与其他变量声明分开，有时还按模块的类型分组。这个规则可以帮助你执行这个惯例。

规则细节

当这个规则被启用时，每个 var 语句必须满足以下条件。

• 没有或所有变量声明必须是 require 声明（默认）。
• 所有的 requirement 声明必须是相同的类型（分组）

这条规则区分了六种变量声明的类型：

• core：声明必要的核心模块
• file：声明必要的文件模块
• module：声明来自 node_modules 文件夹 的必要模块
• computed：声明所需的模块，其类型无法确定（要么是因为它是计算出来的，要么是因为 require 的调用没有参数）
• uninitialized：一个没有被初始化的声明
• other：任何其他类型的声明。

在本文件中，前四种类型被归纳为 require 声明这一术语。

var fs = require('fs'),        // "core"     \
    async = require('async'),  // "module"   |- these are "require declaration"s
    foo = require('./foo'),    // "file"     |
    bar = require(getName()),  // "computed" /
    baz = 42,                  // "other"
    bam;                       // "uninitialized"
1
2
3
4
5
6

选项

这个规则可以有一个对象字面的选项，其两个属性默认为 false 值。

用一个布尔值选项 true 来配置这个规则是不可取的。

使用此规则与默认的 { "grouping": false, "allowCall": false } 选项的错误示例：

/*eslint no-mixed-requires: "error"*/

var fs = require('fs'),
    i = 0;

var async = require('async'),
    debug = require('diagnostics').someFunction('my-module'),
    eslint = require('eslint');
1
2
3
4
5
6
7
8

使用此规则与默认的 { "grouping": false, "allowCall": false } 选项的正确示例：

/*eslint no-mixed-requires: "error"*/

// only require declarations (grouping off)
var eventEmitter = require('events').EventEmitter,
    myUtils = require('./utils'),
    util = require('util'),
    bar = require(getBarModuleName());

// only non-require declarations
var foo = 42,
    bar = 'baz';

// always valid regardless of grouping because all declarations are of the same type
var foo = require('foo' + VERSION),
    bar = require(getBarModuleName()),
    baz = require();
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

grouping

使用此规则与 { "grouping": true } 选项的错误示例：

/*eslint no-mixed-requires: ["error", { "grouping": true }]*/

// invalid because of mixed types "core" and "module"
var fs = require('fs'),
    async = require('async');

// invalid because of mixed types "file" and "unknown"
var foo = require('foo'),
    bar = require(getBarModuleName());
1
2
3
4
5
6
7
8
9

allowCall

使用此规则与 { "allowCall": true } 选项的错误示例：

/*eslint no-mixed-requires: ["error", { "allowCall": true }]*/

var async = require('async'),
    debug = require('diagnostics').someFunction('my-module'), /* allowCall doesn't allow calling any function */
    eslint = require('eslint');
1
2
3
4
5

使用此规则与 { "allowCall": true } 选项的正确示例：

/*eslint no-mixed-requires: ["error", { "allowCall": true }]*/

var async = require('async'),
    debug = require('diagnostics')('my-module'),
    eslint = require('eslint');
1
2
3
4
5

已知限制

• 该实现不知道任何名称为 require 的本地函数可能会影射 Node.js 的全局 require。

• 在内部，核心模块的列表是通过 require("rep")._builtinLibs 检索的。如果你在 ESLint 和你的应用程序中使用不同版本的 Node.js，每个版本的核心模块列表可能是不同的。 上面提到的 _builtinLibs 属性在 0.8 版本中开始使用，对于早期版本，硬编码的模块名称列表被用作后备。如果你的 Node.js 版本早于 0.6，该列表可能是不准确的。

何时不用

如果你使用 UMD 这样的模式，在变量声明中不加载 required 模块，这个规则显然对你毫无帮助。

Version

This rule was introduced in ESLint v0.0.9.

Resources

• Rule source
• Tests source