Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(linter): add the import/no_named_default rule #7902

Merged
merged 2 commits into from
Dec 17, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions crates/oxc_linter/src/rules.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ mod import {
pub mod no_dynamic_require;
pub mod no_named_as_default;
pub mod no_named_as_default_member;
pub mod no_named_default;
pub mod no_namespace;
pub mod no_self_import;
pub mod no_webpack_loader_syntax;
Expand Down Expand Up @@ -643,6 +644,7 @@ oxc_macros::declare_all_lint_rules! {
import::default,
import::export,
import::first,
import::no_named_default,
import::no_namespace,
import::max_dependencies,
import::named,
Expand Down
74 changes: 74 additions & 0 deletions crates/oxc_linter/src/rules/import/no_named_default.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
use oxc_diagnostics::OxcDiagnostic;
use oxc_macros::declare_oxc_lint;
use oxc_span::Span;

use crate::{context::LintContext, module_record::ImportImportName, rule::Rule};

fn no_named_default_diagnostic(span: Span) -> OxcDiagnostic {
OxcDiagnostic::warn("Replace default import with named import.")
.with_help("Forbid named default exports.")
.with_label(span)
}

#[derive(Debug, Default, Clone)]
pub struct NoNamedDefault;

declare_oxc_lint!(
/// ### What it does
/// Reports use of a default export as a locally named import.
///
/// ### Why is this bad?
/// Rationale: the syntax exists to import default exports expressively, let's use it.
///
/// ### Examples
///
/// Examples of **incorrect** code for this rule:
/// ```js
/// // message: Using exported name 'bar' as identifier for default export.
/// import { default as foo } from './foo.js';
/// import { default as foo, bar } from './foo.js';
/// ```
///
/// Examples of **correct** code for this rule:
/// ```js
/// import foo from './foo.js';
/// import foo, { bar } from './foo.js';
/// ```
NoNamedDefault,
style,
pending // TODO: describe fix capabilities. Remove if no fix can be done,
// keep at 'pending' if you think one could be added but don't know how.
// Options are 'fix', 'fix_dangerous', 'suggestion', and 'conditional_fix_suggestion'
);

impl Rule for NoNamedDefault {
fn run_once(&self, ctx: &LintContext) {
ctx.module_record().import_entries.iter().for_each(|entry| {
let ImportImportName::Name(import_name) = &entry.import_name else {
return;
};
if import_name.name() == "default" && !entry.is_type {
ctx.diagnostic(no_named_default_diagnostic(entry.module_request.span()));
}
});
}
}

#[test]
fn test() {
use crate::tester::Tester;

let pass = vec![
r#"import bar from "./bar";"#,
r#"import bar, { foo } from "./bar";"#,
r#"import { type default as Foo } from "./bar";"#,
];

let fail = vec![
r#"import { default as bar } from "./bar";"#,
r#"import { foo, default as bar } from "./bar";"#,
r#"import { "default" as bar } from "./bar";"#,
];

Tester::new(NoNamedDefault::NAME, NoNamedDefault::CATEGORY, pass, fail).test_and_snapshot();
}
24 changes: 24 additions & 0 deletions crates/oxc_linter/src/snapshots/import_no_named_default.snap
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
source: crates/oxc_linter/src/tester.rs
snapshot_kind: text
---
⚠ eslint-plugin-import(no-named-default): Replace default import with named import.
╭─[no_named_default.tsx:1:32]
1 │ import { default as bar } from "./bar";
· ───────
╰────
help: Forbid named default exports.

⚠ eslint-plugin-import(no-named-default): Replace default import with named import.
╭─[no_named_default.tsx:1:37]
1 │ import { foo, default as bar } from "./bar";
· ───────
╰────
help: Forbid named default exports.

⚠ eslint-plugin-import(no-named-default): Replace default import with named import.
╭─[no_named_default.tsx:1:34]
1 │ import { "default" as bar } from "./bar";
· ───────
╰────
help: Forbid named default exports.
Loading