dan/oxc
1
0
Fork 0
mirror of https://github.com/danbulant/oxc synced 2026-05-19 12:19:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

fix(linter): catch Promise in typescript/array-type rule (#8702)

Browse source 
close #8693 

Correctly catch `Promise<string[]>` and `Promise<Array<number>>`.
This commit is contained in:
Rintaro Itokawa 2025-01-25 18:30:33 +09:00 committed by GitHub
parent e8e69179d1
commit f15bdce53b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 76 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

75
crates/oxc_linter/src/rules/typescript/array_type.rs
View file

@ -176,7 +176,7 @@ fn check(
}
if let TSType::TSTypeReference(ts_type_reference) = &type_annotation {
check_and_report_error_array(default_config, readonly_config, ts_type_reference, ctx);
check_and_report_error_reference(default_config, readonly_config, ts_type_reference, ctx);
}
}
@ -238,6 +238,65 @@ fn check_and_report_error_generic(
});
}
fn check_and_report_error_reference(
default_config: &ArrayOption,
readonly_config: &ArrayOption,
ts_type_reference: &TSTypeReference,
ctx: &LintContext,
) {
if let TSTypeName::IdentifierReference(ident_ref_type_name) = &ts_type_reference.type_name {
if ident_ref_type_name.name.as_str() == "ReadonlyArray"
|| ident_ref_type_name.name.as_str() == "Array"
{
check_and_report_error_array(default_config, readonly_config, ts_type_reference, ctx);
} else if ident_ref_type_name.name.as_str() == "Promise" {
if let Some(type_params) = &ts_type_reference.type_parameters {
if type_params.params.len() == 1 {
if let Some(type_param) = type_params.params.first() {
if let TSType::TSArrayType(array_type) = &type_param {
check_and_report_error_generic(
default_config,
array_type.span,
&array_type.element_type,
ctx,
false,
);
}
if let TSType::TSTypeOperatorType(ts_operator_type) = &type_param {
if matches!(
&ts_operator_type.operator,
TSTypeOperatorOperator::Readonly
) {
if let TSType::TSArrayType(array_type) =
&ts_operator_type.type_annotation
{
check_and_report_error_generic(
readonly_config,
ts_operator_type.span,
&array_type.element_type,
ctx,
true,
);
}
}
}
if let TSType::TSTypeReference(ts_type_reference) = &type_param {
check_and_report_error_reference(
default_config,
readonly_config,
ts_type_reference,
ctx,
);
}
}
}
}
}
}
}
fn check_and_report_error_array(
default_config: &ArrayOption,
readonly_config: &ArrayOption,
@ -248,11 +307,6 @@ fn check_and_report_error_array(
return;
};
if ident_ref_type_name.name.as_str() != "ReadonlyArray"
&& ident_ref_type_name.name.as_str() != "Array"
{
return;
}
let is_readonly_array_type = ident_ref_type_name.name == "ReadonlyArray";
let config = if is_readonly_array_type { readonly_config } else { default_config };
if matches!(config, ArrayOption::Generic) {
@ -1116,6 +1170,10 @@ fn test() {
"const foo: ReadonlyArray<new (...args: any[]) => void> = [];",
Some(serde_json::json!([{"default":"array"}])),
),
(
"let a: Promise<string[]> = Promise.resolve([]);",
Some(serde_json::json!([{"default": "generic"}])),
),
];
let fix: Vec<(&str, &str, Option<serde_json::Value>)> = vec![
@ -1643,6 +1701,11 @@ fn test() {
"const foo: readonly (new (...args: any[]) => void)[] = [];",
Some(serde_json::json!([{"default":"array"}])),
),
(
"let a: Promise<string[]> = Promise.resolve([]);",
"let a: Promise<Array<string>> = Promise.resolve([]);",
Some(serde_json::json!([{"default": "generic"}])),
),
];
Tester::new(ArrayType::NAME, ArrayType::PLUGIN, pass, fail).expect_fix(fix).test_and_snapshot();

7
crates/oxc_linter/src/snapshots/typescript_array_type.snap
View file

@ -652,3 +652,10 @@ source: crates/oxc_linter/src/tester.rs
· ───────────────────────────────────────────
╰────
help: Replace `ReadonlyArray<new (...args: any[]) => void>` with `readonly (new (...args: any[]) => void)[]`.
⚠ typescript-eslint(array-type): Array type using 'string[]' is forbidden. Use 'Array<string>' instead.
╭─[array_type.tsx:1:16]
1 │ let a: Promise<string[]> = Promise.resolve([]);
· ────────
╰────
help: Replace `string[]` with `Array<string>`.