noConsole

JavaScript (and super languages)

Summary

Rule available since: v1.6.0
Diagnostic Category: lint/suspicious/noConsole
This rule has an unsafe fix.
The default severity of this rule is information.
Sources:
- Same as no-console

Description

Disallow the use of console.

In a browser environment, it’s considered a best practice to log messages using console. Such messages are considered to be for debugging purposes and therefore not suitable to ship to the client. In general, calls using console should be stripped before being pushed to production.

Examples

Invalid

1
console.error('hello world')

code-block.js:1:1 lint/suspicious/noConsole  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Don’t use console.
  
  > 1 │ console.error(‘hello world’)
      │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    2 │ 
  
  ℹ The use of console is often reserved for debugging.
  
  ℹ Unsafe fix: Remove console.
  
    1 │ console.error(‘hello·world’)
      │ ----------------------------

Options

Use the options to explicitly allow a specific subset of console methods.

1
{
2
  "options": {
3
    "allow": ["assert", "error", "info", "warn"]
4
  }
5
}

1
console.error("error message"); // Allowed
2
console.warn("warning message"); // Allowed
3
console.info("info message"); // Allowed
4
console.log("log message");
5
console.assert(true, "explanation"); // Allowed

code-block.js:1:1 lint/suspicious/noConsole  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Don’t use console.
  
  > 1 │ console.error(“error message”); // Allowed
      │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    2 │ console.warn(“warning message”); // Allowed
    3 │ console.info(“info message”); // Allowed
  
  ℹ The use of console is often reserved for debugging.
  
  ℹ Unsafe fix: Remove console.
  
    1 │ console.error(“error·message”);·//·Allowed
      │ ------------------------------------------
code-block.js:2:1 lint/suspicious/noConsole  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Don’t use console.
  
    1 │ console.error(“error message”); // Allowed
  > 2 │ console.warn(“warning message”); // Allowed
      │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    3 │ console.info(“info message”); // Allowed
    4 │ console.log(“log message”);
  
  ℹ The use of console is often reserved for debugging.
  
  ℹ Unsafe fix: Remove console.
  
    1 1 │   console.error(“error message”); // Allowed
    2   │ - console.warn(“warning·message”);·//·Allowed
    3 2 │   console.info(“info message”); // Allowed
    4 3 │   console.log(“log message”);
  
code-block.js:3:1 lint/suspicious/noConsole  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Don’t use console.
  
    1 │ console.error(“error message”); // Allowed
    2 │ console.warn(“warning message”); // Allowed
  > 3 │ console.info(“info message”); // Allowed
      │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    4 │ console.log(“log message”);
    5 │ console.assert(true, “explanation”); // Allowed
  
  ℹ The use of console is often reserved for debugging.
  
  ℹ Unsafe fix: Remove console.
  
    1 1 │   console.error(“error message”); // Allowed
    2 2 │   console.warn(“warning message”); // Allowed
    3   │ - console.info(“info·message”);·//·Allowed
    4 3 │   console.log(“log message”);
    5 4 │   console.assert(true, “explanation”); // Allowed
  
code-block.js:4:1 lint/suspicious/noConsole  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Don’t use console.
  
    2 │ console.warn(“warning message”); // Allowed
    3 │ console.info(“info message”); // Allowed
  > 4 │ console.log(“log message”);
      │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^
    5 │ console.assert(true, “explanation”); // Allowed
    6 │ 
  
  ℹ The use of console is often reserved for debugging.
  
  ℹ Unsafe fix: Remove console.
  
    2 2 │   console.warn(“warning message”); // Allowed
    3 3 │   console.info(“info message”); // Allowed
    4   │ - console.log(“log·message”);
    5 4 │   console.assert(true, “explanation”); // Allowed
    6 5 │   
  
code-block.js:5:1 lint/suspicious/noConsole  FIXABLE  ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  ℹ Don’t use console.
  
    3 │ console.info(“info message”); // Allowed
    4 │ console.log(“log message”);
  > 5 │ console.assert(true, “explanation”); // Allowed
      │ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    6 │ 
  
  ℹ The use of console is often reserved for debugging.
  
  ℹ Unsafe fix: Remove console.
  
    3 3 │   console.info(“info message”); // Allowed
    4 4 │   console.log(“log message”);
    5   │ - console.assert(true,·“explanation”);·//·Allowed
    6 5 │

How to configure

1
{
2
  "linter": {
3
    "rules": {
4
      "suspicious": {
5
        "noConsole": "error"
6
      }
7
    }
8
  }
9
}