global-require

此规则在 ESLint v7.0.0 中已弃用。请使用 eslint-plugin-node 中的相应规则。

在 Node.js 中，模块依赖是使用 require() 函数包含的，例如：

var fs = require("fs");

虽然 require() 可以在代码中的任何位置调用，但一些样式指南规定它只能在模块的顶层调用，以便更容易识别依赖关系。例如，当它们深深嵌套在函数和其他语句中时，可以说更难识别依赖关系：

function foo() {
    if (condition) {
        var fs = require("fs");
    }
}

由于 require() 进行同步加载，因此在其他位置使用时可能会导致性能问题。

此外，ES6 模块要求 import 和 export 语句只能出现在模块主体的顶层。

规则详情

该规则要求对 require() 的所有调用都位于模块的顶层，类似于 ES6 import 和 export 语句，这也只能发生在顶层。

此规则的错误代码示例：

/*eslint global-require: "error"*/
/*eslint-env es6*/

// calling require() inside of a function is not allowed
function readFile(filename, callback) {
    var fs = require("fs");
    fs.readFile(filename, callback);
}

// conditional requires like this are also not allowed
if (DEBUG) {
    require("debug");
}

// a require() in a switch statement is also flagged
switch (x) {
    case "1":
        require("1");
        break;
}

// you may not require() inside an arrow function body
var getModule = (name) => require(name);

// you may not require() inside of a function body as well
function getModule(name) {
    return require(name);
}

// you may not require() inside of a try/catch block
try {
    require(unsafeModule);
} catch (e) {
    console.log(e);
}

此规则的正确代码示例：

/*eslint global-require: "error"*/

// all these variations of require() are ok
require("x");
var y = require("y");
var z;
z = require("z").initialize();

// requiring a module and using it in a function is ok
var fs = require("fs");
function readFile(filename, callback) {
    fs.readFile(filename, callback);
}

// you can use a ternary to determine which module to require
var logger = DEBUG ? require("dev-logger") : require("logger");

// if you want you can require() at the end of your module
function doSomethingA() {}
function doSomethingB() {}
var x = require("x"),
    z = require("z");

何时不使用

如果您有一个必须使用来自文件系统的信息初始化的模块，或者如果一个模块仅在非常罕见的情况下使用并且会导致加载大量开销，那么禁用该规则可能是有意义的。如果您需要在 try/catch 中添加 require() 可选依赖项，则可以使用 // eslint-disable-line global-require 注释禁用该规则仅针对该依赖项。