Skip to content

Commit

Permalink
fix(linter): rule no-restricted-imports: improve diagnostics
Browse files Browse the repository at this point in the history
  • Loading branch information
@Sysix
Sysix committed Dec 30, 2024
1 parent 33e4842 commit 12911f4
Show file tree
Hide file tree
Showing 2 changed files with 62 additions and 12 deletions.
62 changes: 56 additions & 6 deletions crates/oxc_linter/src/rules/eslint/no_restricted_imports.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -743,6 +743,14 @@ impl NoRestrictedImports {
import_names.join(", ").as_str(),
source,
)
} else if let Some(import_name_patterns) = &pattern.import_name_pattern
{
diagnostic_pattern_and_everything_with_regex_import_name(
entry.module_request.span(),
pattern.message.clone(),
&import_name_patterns,
source,
)
} else if let Some(allowed_import_names) = &pattern.allow_import_names {
diagnostic_everything_with_allowed_import_name(
entry.module_request.span(),
Expand Down Expand Up @@ -903,6 +911,14 @@ impl NoRestrictedImports {
import_names.join(", ").as_str(),
source,
)
} else if let Some(import_name_patterns) = &pattern.import_name_pattern
{
diagnostic_pattern_and_everything_with_regex_import_name(
span,
pattern.message.clone(),
&import_name_patterns,
source,
)
} else if let Some(allow_import_name_pattern) =
&pattern.allow_import_name_pattern
{
Expand All @@ -926,12 +942,26 @@ impl NoRestrictedImports {
diagnostic
}
IsSkipAbleResult::NameDisallowed(name_span) => {
diagnostic_pattern_and_import_name(
name_span.clone().span(),
pattern.message.clone(),
name_span.name(),
source,
)
let diagnostic = if let Some(allow_import_name_pattern) =
&pattern.allow_import_name_pattern
{
diagnostic_allowed_import_name_pattern(
name_span.clone().span(),
pattern.message.clone(),
name_span.name(),
source,
allow_import_name_pattern.as_str(),
)
} else {
diagnostic_pattern_and_import_name(
name_span.clone().span(),
pattern.message.clone(),
name_span.name(),
source,
)
};

diagnostic
}
IsSkipAbleResult::Allowed => panic!("unreachable"),
};
Expand Down Expand Up @@ -1508,6 +1538,8 @@ fn test() {
}]
}])),
),
// expect: 'default' import from 'foo' is restricted
// got: 'foo' import is restricted from being used.
(
r#"import DisallowedObject from "foo";"#,
Some(serde_json::json!([{
Expand Down Expand Up @@ -1838,6 +1870,8 @@ fn test() {
]
}])),
),
// expect: 'default' import from 'mod' is restricted.
// got: 'mod' import is restricted from being used.
(
"import foo, { bar } from 'mod';",
Some(serde_json::json!([{
Expand Down Expand Up @@ -1875,6 +1909,8 @@ fn test() {
}]
}])),
),
// expected: 'default' import from 'mod' is restricted.
// got: 'mod' import is restricted from being used.
(
"import foo, { default as bar } from 'mod';",
Some(serde_json::json!([{
Expand Down Expand Up @@ -1941,6 +1977,8 @@ fn test() {
}]
}])),
),
// expected: 'default' import from 'mod' is restricted from being used by a pattern.
// got: 'mod' import is restricted from being used by a pattern.
(
"import def, * as ns from 'mod';",
Some(serde_json::json!([{
Expand All @@ -1950,6 +1988,8 @@ fn test() {
}]
}])),
),
// expected: 'default' import from 'mod' is restricted from being used by a pattern.
// got: 'mod' import is restricted from being used by a pattern.
(
"import Foo from 'mod';",
Some(serde_json::json!([{
Expand Down Expand Up @@ -2139,6 +2179,8 @@ fn test() {
}]
}])),
),
// expected: * import is invalid because import name matching '/^Foo/u' pattern from 'foo' is restricted from being used.
// got: 'foo' import is restricted from being used by a pattern.
(
"export * from 'foo';",
Some(serde_json::json!([{
Expand Down Expand Up @@ -2186,6 +2228,8 @@ fn test() {
}]
}])),
),
// expected: 'DisallowedObject' import from 'foo' is restricted because only 'AllowedObject' import(s) is/are allowed.
// got: 'DisallowedObject' import from 'foo' is restricted from being used by a pattern.
(
r#"import { AllowedObject, DisallowedObject } from "foo";"#,
Some(serde_json::json!([{
Expand All @@ -2195,6 +2239,8 @@ fn test() {
}]
}])),
),
// expected: 'DisallowedObject' import from 'foo' is restricted because only 'AllowedObject' import(s) is/are allowed.
// got: 'DisallowedObject' import from 'foo' is restricted from being used by a pattern.
(
r#"import { AllowedObject, DisallowedObject } from "foo";"#,
Some(serde_json::json!([{
Expand Down Expand Up @@ -2278,6 +2324,8 @@ fn test() {
}]
}])),
),
// expected: 'Foo' import from '../../my/relative-module' is restricted from being used by a pattern.
// got: '../../my/relative-module' import is restricted from being used by a pattern.
(
"import { Foo } from '../../my/relative-module';",
Some(serde_json::json!([{
Expand All @@ -2297,6 +2345,8 @@ fn test() {
}]
}])),
),
// expected: 'Foo_*' import from '@app/api' is restricted from being used by a pattern.
// got: '@app/api/bar' import is restricted from being used by a pattern.
(
"
// error
Expand Down
12 changes: 6 additions & 6 deletions crates/oxc_linter/src/snapshots/eslint_no_restricted_imports.snap
View file
Original file line number Diff line number Diff line change
Expand Up @@ -604,19 +604,19 @@ snapshot_kind: text
· ───
╰────

⚠ eslint(no-restricted-imports): 'foo' import is restricted from being used by a pattern.
⚠ eslint(no-restricted-imports): * import is invalid because import name matching '^Foo' pattern from 'foo' is restricted from being used.
╭─[no_restricted_imports.tsx:1:22]
1 │ import * as Foo from 'foo';
· ─────
╰────

⚠ eslint(no-restricted-imports): '../../my/relative-module' import is restricted from being used by a pattern.
⚠ eslint(no-restricted-imports): * import is invalid because import name matching '^Foo' pattern from '../../my/relative-module' is restricted from being used.
╭─[no_restricted_imports.tsx:1:22]
1 │ import * as All from '../../my/relative-module';
· ──────────────────────────
╰────

⚠ eslint(no-restricted-imports): '../../my/relative-module' import is restricted from being used by a pattern.
⚠ eslint(no-restricted-imports): * import is invalid because import name matching '^Foo' pattern from '../../my/relative-module' is restricted from being used.
╭─[no_restricted_imports.tsx:1:39]
1 │ import * as AllWithCustomMessage from '../../my/relative-module';
· ──────────────────────────
Expand Down Expand Up @@ -684,19 +684,19 @@ snapshot_kind: text
· ───
╰────

⚠ eslint(no-restricted-imports): 'foo' import is restricted from being used by a pattern.
⚠ eslint(no-restricted-imports): * import is invalid because import name matching '^Foo' pattern from 'foo' is restricted from being used.
╭─[no_restricted_imports.tsx:1:15]
1 │ export * from 'foo';
· ─────
╰────

⚠ eslint(no-restricted-imports): 'Bar' import from 'foo' is restricted from being used by a pattern.
⚠ eslint(no-restricted-imports): 'Bar' import from 'foo' is restricted because only imports that match the pattern '^Foo' are allowed from 'foo'.
╭─[no_restricted_imports.tsx:1:10]
1 │ export { Bar } from 'foo';
· ───
╰────

⚠ eslint(no-restricted-imports): 'Bar' import from 'foo' is restricted from being used by a pattern.
⚠ eslint(no-restricted-imports): 'Bar' import from 'foo' is restricted because only imports that match the pattern '^Foo' are allowed from 'foo'.
╭─[no_restricted_imports.tsx:1:10]
1 │ export { Bar } from 'foo';
· ───
Expand Down

0 comments on commit 12911f4

Please sign in to comment.