Skip to content

fix(linter/consistent-type-definitions): handle parenthesized types in rule #16998

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.

Sign up for GitHub

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

Merged
graphite-app merged 1 commit into from
Dec 17, 2025
Merged

fix(linter/consistent-type-definitions): handle parenthesized types in rule #16998

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
97 changes: 55 additions & 42 deletions crates/oxc_linter/src/rules/typescript/consistent_type_definitions.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,50 +99,53 @@ impl Rule for ConsistentTypeDefinitions {

fn run<'a>(&self, node: &AstNode<'a>, ctx: &LintContext<'a>) {
match node.kind() {
AstKind::TSTypeAliasDeclaration(decl) => match &decl.type_annotation {
TSType::TSTypeLiteral(_)
if self.0 == ConsistentTypeDefinitionsConfig::Interface =>
{
let start = if decl.declare {
let base_start = decl.span.start + 7;

ctx.find_next_token_from(base_start, "type")
.map_or(base_start + 1, |v| v + base_start)
} else {
decl.span.start
};

let name_span_start = &decl.id.span.start;
let mut name_span_end = &decl.id.span.end;

if let Some(params) = &decl.type_parameters {
name_span_end = &params.span.end;
}

let name =
&ctx.source_text()[*name_span_start as usize..*name_span_end as usize];

if let TSType::TSTypeLiteral(type_ann) = &decl.type_annotation {
let body_span = type_ann.span;
let body =
&ctx.source_text()[body_span.start as usize..body_span.end as usize];

ctx.diagnostic_with_fix(
consistent_type_definitions_diagnostic(
ConsistentTypeDefinitionsConfig::Interface,
Span::new(start, start + 4),
),
|fixer| {
fixer.replace(
Span::new(start, decl.span.end),
format!("interface {name} {body}"),
)
},
);
AstKind::TSTypeAliasDeclaration(decl) => {
let type_annotation = decl.type_annotation.without_parenthesized();
match type_annotation {
TSType::TSTypeLiteral(_)
if self.0 == ConsistentTypeDefinitionsConfig::Interface =>
{
let start = if decl.declare {
let base_start = decl.span.start + 7;

ctx.find_next_token_from(base_start, "type")
.map_or(base_start + 1, |v| v + base_start)
} else {
decl.span.start
};

let name_span_start = &decl.id.span.start;
let mut name_span_end = &decl.id.span.end;

if let Some(params) = &decl.type_parameters {
name_span_end = &params.span.end;
}

let name =
&ctx.source_text()[*name_span_start as usize..*name_span_end as usize];

if let TSType::TSTypeLiteral(type_ann) = type_annotation {
let body_span = type_ann.span;
let body = &ctx.source_text()
[body_span.start as usize..body_span.end as usize];

ctx.diagnostic_with_fix(
consistent_type_definitions_diagnostic(
ConsistentTypeDefinitionsConfig::Interface,
Span::new(start, start + 4),
),
|fixer| {
fixer.replace(
Span::new(start, decl.span.end),
format!("interface {name} {body}"),
)
},
);
}
}
_ => {}
}
_ => {}
},
}

AstKind::ExportDefaultDeclaration(exp) => match &exp.declaration {
ExportDefaultDeclarationKind::TSInterfaceDeclaration(decl)
Expand Down Expand Up @@ -386,6 +389,9 @@ fn test() {
("export declare…interface S {}", Some(serde_json::json!(["type"]))),
("declare /* interface */ interface T { x: number; };", Some(serde_json::json!(["type"]))),
("declare /* type */ type T = { x: number; };", Some(serde_json::json!(["interface"]))),
("type foo = ({});", Some(serde_json::json!(["interface"]))),
("type foo = (({}));", Some(serde_json::json!(["interface"]))),
("type foo = ({ x: number });", Some(serde_json::json!(["interface"]))),
];

let fix = vec![
Expand Down Expand Up @@ -544,6 +550,13 @@ export declare type Test = {
"export declare…type S = {}",
Some(serde_json::json!(["type"])),
),
("type foo = ({});", "interface foo {}", Some(serde_json::json!(["interface"]))),
("type foo = (({}));", "interface foo {}", Some(serde_json::json!(["interface"]))),
(
"type foo = ({ x: number });",
"interface foo { x: number }",
Some(serde_json::json!(["interface"])),
),
];

let fix_dangerous = vec![
Expand Down
21 changes: 21 additions & 0 deletions crates/oxc_linter/src/snapshots/typescript_consistent_type_definitions.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,3 +240,24 @@ source: crates/oxc_linter/src/tester.rs
· ────
╰────
help: Replace `type T = { x: number; };` with `interface T { x: number; }`.

⚠ typescript-eslint(consistent-type-definitions): Use `interface` instead of `type`.
╭─[consistent_type_definitions.tsx:1:1]
1 │ type foo = ({});
· ────
╰────
help: Replace `type foo = ({});` with `interface foo {}`.

⚠ typescript-eslint(consistent-type-definitions): Use `interface` instead of `type`.
╭─[consistent_type_definitions.tsx:1:1]
1 │ type foo = (({}));
· ────
╰────
help: Replace `type foo = (({}));` with `interface foo {}`.

⚠ typescript-eslint(consistent-type-definitions): Use `interface` instead of `type`.
╭─[consistent_type_definitions.tsx:1:1]
1 │ type foo = ({ x: number });
· ────
╰────
help: Replace `type foo = ({ x: number });` with `interface foo { x: number }`.
Loading