no-console

禁止使用 console

在设计为在浏览器中执行的 JavaScript 中，避免在 console 上使用方法被认为是最佳实践。此类消息被认为是出于调试目的，因此不适合发送给客户端。一般来说，使用 console 的调用应该在被推送到生产环境之前被剥离。

console.log("Made it here.");
console.error("That shouldn't have happened.");

规则详情

此规则不允许调用或分配 console 对象的方法。

此规则的错误代码示例：

/* eslint no-console: "error" */

console.log("Log a debug level message.");
console.warn("Log a warn level message.");
console.error("Log an error level message.");
console.log = foo();

此规则的正确代码示例：

/* eslint no-console: "error" */

// custom console
Console.log("Hello world!");

选项

此规则有一个异常对象选项：

• "allow" 有一个字符串数组，这些字符串是 console 对象的允许方法

带有示例 { "allow": ["warn", "error"] } 选项的此规则的其他正确代码示例：

/* eslint no-console: ["error", { allow: ["warn", "error"] }] */

console.warn("Log a warn level message.");
console.error("Log an error level message.");

何时不使用

但是，如果您使用的是 Node.js，则 console 用于向用户输出信息，因此不严格用于调试目的。如果您正在为 Node.js 开发，那么您很可能不希望启用此规则。

您可能不使用此规则的另一种情况是，如果您想强制执行控制台调用而不是控制台覆盖。例如：

/* eslint no-console: ["error", { allow: ["warn"] }] */
console.error = function (message) {
  throw new Error(message);
};

使用上例中的 no-console 规则，ESLint 会报错。对于上面的示例，您可以禁用规则：

// eslint-disable-next-line no-console
console.error = function (message) {
  throw new Error(message);
};

// or

console.error = function (message) {  // eslint-disable-line no-console
  throw new Error(message);
};

但是，您可能不想手动添加 eslint-disable-next-line 或 eslint-disable-line。使用 no-restricted-syntax 规则可以达到控制台调用只接收错误的效果：

{
    "rules": {
        "no-console": "off",
        "no-restricted-syntax": [
            "error",
            {
                "selector": "CallExpression[callee.object.name='console'][callee.property.name!=/^(log|warn|error|info|trace)$/]",
                "message": "Unexpected property on console object was called"
            }
        ]
    }
}