Skip to content

Commit

Permalink
fix(linter): report no-console when the globals.console is off (#…
Browse files Browse the repository at this point in the history 
…9138)

It feels like looking into the globals is the right choice.
Then we should report only when `console` is defined in `globals`, or in envs `browser, node, (service-)worker, ...`.

I do not think the original rule looks into the globals:
https://eslint.org/docs/latest/rules/no-console
  • Loading branch information
@Sysix
Sysix committed Feb 15, 2025
1 parent 3576318 commit 23d0d95
Show file tree
Hide file tree
Showing 2 changed files with 60 additions and 26 deletions.
72 changes: 46 additions & 26 deletions crates/oxc_linter/src/rules/eslint/no_console.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,8 @@ impl Rule for NoConsole {
return;
};

if ctx.is_reference_to_global_variable(ident)
&& ident.name == "console"
if ident.name == "console"
&& ctx.scopes().root_unresolved_references().contains_key(ident.name.as_str())
&& !self.allow.iter().any(|s| mem.static_property_name().is_some_and(|f| f == s))
{
if let Some((mem_span, _)) = mem.static_property_info() {
Expand Down Expand Up @@ -144,33 +144,53 @@ fn test() {
use crate::tester::Tester;

let pass = vec![
("Console.info(foo)", None),
("console.info(foo)", Some(serde_json::json!([{ "allow": ["info"] }]))),
("console.warn(foo)", Some(serde_json::json!([{ "allow": ["warn"] }]))),
("console.error(foo)", Some(serde_json::json!([{ "allow": ["error"] }]))),
("console.log(foo)", Some(serde_json::json!([{ "allow": ["log"] }]))),
("console.info(foo)", Some(serde_json::json!([{ "allow": ["warn", "info"] }]))),
("console.warn(foo)", Some(serde_json::json!([{ "allow": ["error", "warn"] }]))),
("console.error(foo)", Some(serde_json::json!([{ "allow": ["log", "error"] }]))),
("console.log(foo)", Some(serde_json::json!([{ "allow": ["info", "log", "warn"] }]))),
("var console = require('myconsole'); console.log(foo)", None),
("import console from 'myconsole'; console.log(foo)", None),
("Console.info(foo)", None, None),
("console.info(foo)", Some(serde_json::json!([{ "allow": ["info"] }])), None),
(
"console.info(foo)",
Some(serde_json::json!([{ "allow": ["info"] }])),
Some(serde_json::json!({ "env": { "browser": true}})),
),
(
"console.info(foo)",
Some(serde_json::json!([{ "allow": ["info"] }])),
Some(serde_json::json!({ "globals": { "console": "readonly"}})),
),
("console.warn(foo)", Some(serde_json::json!([{ "allow": ["warn"] }])), None),
("console.error(foo)", Some(serde_json::json!([{ "allow": ["error"] }])), None),
("console.log(foo)", Some(serde_json::json!([{ "allow": ["log"] }])), None),
("console.info(foo)", Some(serde_json::json!([{ "allow": ["warn", "info"] }])), None),
("console.warn(foo)", Some(serde_json::json!([{ "allow": ["error", "warn"] }])), None),
("console.error(foo)", Some(serde_json::json!([{ "allow": ["log", "error"] }])), None),
("console.log(foo)", Some(serde_json::json!([{ "allow": ["info", "log", "warn"] }])), None),
("var console = require('myconsole'); console.log(foo)", None, None),
("import console from 'myconsole'; console.log(foo)", None, None),
];

let fail = vec![
("console.log()", None),
("console.log(foo)", None),
("console.error(foo)", None),
("console.info(foo)", None),
("console.warn(foo)", None),
("console.log(foo)", Some(serde_json::json!([{ "allow": ["error"] }]))),
("console.error(foo)", Some(serde_json::json!([{ "allow": ["warn"] }]))),
("console.info(foo)", Some(serde_json::json!([{ "allow": ["log"] }]))),
("console.warn(foo)", Some(serde_json::json!([{ "allow": ["error"] }]))),
("console.log(foo)", Some(serde_json::json!([{ "allow": ["warn", "info"] }]))),
("console.error(foo)", Some(serde_json::json!([{ "allow": ["warn", "info", "log"] }]))),
("console.info(foo)", Some(serde_json::json!([{ "allow": ["warn", "error", "log"] }]))),
("console.warn(foo)", Some(serde_json::json!([{ "allow": ["info", "log"] }]))),
("console.log()", None, None),
("console.log(foo)", None, None),
("console.error(foo)", None, None),
("console.info(foo)", None, None),
("console.warn(foo)", None, None),
("console.log()", None, Some(serde_json::json!({ "env": { "browser": true}}))),
("console.log()", None, Some(serde_json::json!({ "globals": { "console": "off"}}))),
("console.log(foo)", Some(serde_json::json!([{ "allow": ["error"] }])), None),
("console.error(foo)", Some(serde_json::json!([{ "allow": ["warn"] }])), None),
("console.info(foo)", Some(serde_json::json!([{ "allow": ["log"] }])), None),
("console.warn(foo)", Some(serde_json::json!([{ "allow": ["error"] }])), None),
("console.log(foo)", Some(serde_json::json!([{ "allow": ["warn", "info"] }])), None),
(
"console.error(foo)",
Some(serde_json::json!([{ "allow": ["warn", "info", "log"] }])),
None,
),
(
"console.info(foo)",
Some(serde_json::json!([{ "allow": ["warn", "error", "log"] }])),
None,
),
("console.warn(foo)", Some(serde_json::json!([{ "allow": ["info", "log"] }])), None),
];

let fix = vec![
Expand Down
14 changes: 14 additions & 0 deletions crates/oxc_linter/src/snapshots/eslint_no_console.snap
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,20 @@ source: crates/oxc_linter/src/tester.rs
╰────
help: Delete this console statement.

⚠ eslint(no-console): eslint(no-console): Unexpected console statement.
╭─[no_console.tsx:1:1]
1 │ console.log()
· ───────────
╰────
help: Delete this console statement.

⚠ eslint(no-console): eslint(no-console): Unexpected console statement.
╭─[no_console.tsx:1:1]
1 │ console.log()
· ───────────
╰────
help: Delete this console statement.

⚠ eslint(no-console): eslint(no-console): Unexpected console statement.
╭─[no_console.tsx:1:1]
1 │ console.log(foo)
Expand Down

0 comments on commit 23d0d95

Please sign in to comment.