diff --git a/ets2panda/linter/rule-config.json b/ets2panda/linter/rule-config.json index 2b93ff486977b125a56065753460e70bfed70b75..f934bdbb586bc5c6ccfcd68e9b6c875d4602a287 100644 --- a/ets2panda/linter/rule-config.json +++ b/ets2panda/linter/rule-config.json @@ -61,6 +61,7 @@ "arkts-limited-stdlib-no-setTransferList", "arkts-builtin-object-getOwnPropertyNames", "arkts-no-class-omit-interface-optional-prop", + "arkts-distinct-abstract-method-default-return-type", "arkts-class-no-signature-distinct-with-object-public-api", "arkts-no-sparse-array", "arkts-no-enum-prop-as-type", diff --git a/ets2panda/linter/src/lib/CookBookMsg.ts b/ets2panda/linter/src/lib/CookBookMsg.ts index 5a1f71ca6e5a8295412c4ed66c0778beb18e811a..b85b205ccd367808898fe2de482f990d716b48d3 100644 --- a/ets2panda/linter/src/lib/CookBookMsg.ts +++ b/ets2panda/linter/src/lib/CookBookMsg.ts @@ -240,6 +240,8 @@ cookBookTag[185] = 'syntax for import type is disabled (arkts-import-types)'; cookBookTag[186] = '"new" expression with dynamic constructor type is not supported (arkts-no-dynamic-ctor-call)'; cookBookTag[187] = 'function "Math.pow()" behavior for ArkTS differs from Typescript version (arkts-math-pow-standard-diff)'; +cookBookTag[188] = + 'In 1.1, the default type obtained for the abstract method without the annotation type is any. In 1.2, the default type for the abstract method without the annotation type is void. (arkts-distinct-abstract-method-default-return-type)'; cookBookTag[189] = 'Numeric semantics is different for integer values (arkts-numeric-semantic)'; cookBookTag[190] = 'Stricter assignments into variables of function type (arkts-incompatible-function-types)'; cookBookTag[191] = 'ASON is not supported. (arkts-no-need-stdlib-ason)'; diff --git a/ets2panda/linter/src/lib/FaultAttrs.ts b/ets2panda/linter/src/lib/FaultAttrs.ts index f5e7fd5c146f7ff4a61106cbaba134cd2711bcd0..d113dfbf5b014fa2bf217dee6e4f796757849312 100644 --- a/ets2panda/linter/src/lib/FaultAttrs.ts +++ b/ets2panda/linter/src/lib/FaultAttrs.ts @@ -153,6 +153,7 @@ faultsAttrs[FaultID.OptionalMethod] = new FaultAttributes(184); faultsAttrs[FaultID.ImportType] = new FaultAttributes(185); faultsAttrs[FaultID.DynamicCtorCall] = new FaultAttributes(186); faultsAttrs[FaultID.MathPow] = new FaultAttributes(187); +faultsAttrs[FaultID.InvalidAbstractOverrideReturnType] = new FaultAttributes(188); faultsAttrs[FaultID.NumericSemantics] = new FaultAttributes(189); faultsAttrs[FaultID.IncompationbleFunctionType] = new FaultAttributes(190); faultsAttrs[FaultID.LimitedStdLibNoASON] = new FaultAttributes(191); diff --git a/ets2panda/linter/src/lib/FaultDesc.ts b/ets2panda/linter/src/lib/FaultDesc.ts index 2de5c97f1fd54b493f83c4da75745245c4df4872..5b0cd973d51725c8d91eac1e07347b39471628ce 100644 --- a/ets2panda/linter/src/lib/FaultDesc.ts +++ b/ets2panda/linter/src/lib/FaultDesc.ts @@ -147,6 +147,7 @@ faultDesc[FaultID.OptionalMethod] = 'Optional method'; faultDesc[FaultID.ImportType] = 'Import type syntax'; faultDesc[FaultID.DynamicCtorCall] = 'Dynamic constructor call'; faultDesc[FaultID.MathPow] = 'Exponent call'; +faultDesc[FaultID.InvalidAbstractOverrideReturnType] = 'Missing return type on abstract method'; faultDesc[FaultID.IncompationbleFunctionType] = 'Incompationble function type'; faultDesc[FaultID.VoidOperator] = 'Void operator'; faultDesc[FaultID.ExponentOp] = 'Exponent operation'; diff --git a/ets2panda/linter/src/lib/Problems.ts b/ets2panda/linter/src/lib/Problems.ts index f5767b4cb2b111c7a6348cc3f51fcb47bcd302e7..a42ea1c242b1136eb124cec9255b99ac8c1f9bc4 100644 --- a/ets2panda/linter/src/lib/Problems.ts +++ b/ets2panda/linter/src/lib/Problems.ts @@ -145,6 +145,7 @@ export enum FaultID { ImportType, DynamicCtorCall, MathPow, + InvalidAbstractOverrideReturnType, VoidOperator, ExponentOp, RegularExpressionLiteral, diff --git a/ets2panda/linter/src/lib/TypeScriptLinter.ts b/ets2panda/linter/src/lib/TypeScriptLinter.ts index 96b6d40538c1acfb1fb3f4a4c2fadfb8d79b54c5..106f905e3fca15dacf21624f36391ce44fbd682f 100644 --- a/ets2panda/linter/src/lib/TypeScriptLinter.ts +++ b/ets2panda/linter/src/lib/TypeScriptLinter.ts @@ -19,7 +19,13 @@ import { FaultID } from './Problems'; import { TypeScriptLinterConfig } from './TypeScriptLinterConfig'; import type { Autofix } from './autofixes/Autofixer'; import { Autofixer } from './autofixes/Autofixer'; -import { PROMISE_METHODS, PROMISE_METHODS_WITH_NO_TUPLE_SUPPORT, SYMBOL, SYMBOL_CONSTRUCTOR, TsUtils } from './utils/TsUtils'; +import { + PROMISE_METHODS, + PROMISE_METHODS_WITH_NO_TUPLE_SUPPORT, + SYMBOL, + SYMBOL_CONSTRUCTOR, + TsUtils +} from './utils/TsUtils'; import { FUNCTION_HAS_NO_RETURN_ERROR_CODE } from './utils/consts/FunctionHasNoReturnErrorCode'; import { LIMITED_STANDARD_UTILITY_TYPES, @@ -3917,6 +3923,7 @@ export class TypeScriptLinter extends BaseTypeScriptLinter { this.handleLimitedVoidFunction(tsMethodDecl); this.checkVoidLifecycleReturn(tsMethodDecl); this.handleNoDeprecatedApi(tsMethodDecl); + this.checkAbstractOverrideReturnType(tsMethodDecl); } private checkObjectPublicApiMethods(node: ts.ClassDeclaration | ts.InterfaceDeclaration): void { @@ -10512,6 +10519,110 @@ export class TypeScriptLinter extends BaseTypeScriptLinter { return undefined; } + /** + * If a class method overrides a base-class abstract method that had no explicit return type, + * then any explicit return type other than `void` is an error. + * Also flags async overrides with no explicit annotation. + */ + private checkAbstractOverrideReturnType(method: ts.MethodDeclaration): void { + if (!this.options.arkts2) { + return; + } + + const baseClass = this.getDirectBaseClassOfGivenMethodDecl(method); + if (!baseClass) { + return; + } + + // Locate the abstract method in the inheritance chain + const methodName = method.name.getText(); + const baseMethod = this.findAbstractMethodInBaseChain(baseClass, methodName); + if (!baseMethod) { + return; + } + + // Only if base had no explicit return type + if (baseMethod.type) { + return; + } + + // If override declares a return type, and it isn't void → error + if (method.type && method.type.kind !== ts.SyntaxKind.VoidKeyword) { + const target = ts.isIdentifier(method.name) ? method.name : method; + this.incrementCounters(target, FaultID.InvalidAbstractOverrideReturnType); + + // Also catch async overrides with no explicit annotation (defaulting to Promise) + } else if (TsUtils.hasModifier(method.modifiers, ts.SyntaxKind.AsyncKeyword)) { + const target = ts.isIdentifier(method.name) ? method.name : method; + this.incrementCounters(target, FaultID.InvalidAbstractOverrideReturnType); + } + } + + /** + * Finds the direct superclass declaration for the given method's containing class. + * Returns undefined if the class has no extends clause or cannot resolve the base class. + */ + private getDirectBaseClassOfGivenMethodDecl(method: ts.MethodDeclaration): ts.ClassDeclaration | undefined { + // Must live in a class with an extends clause + const classDecl = method.parent; + if (!ts.isClassDeclaration(classDecl) || !classDecl.heritageClauses) { + return undefined; + } + + return this.getBaseClassDeclFromHeritageClause(classDecl.heritageClauses); + } + + /** + * Walks up the inheritance chain starting from `startClass` to find an abstract method + * named `methodName`. Returns the MethodDeclaration if found, otherwise `undefined`. + */ + private findAbstractMethodInBaseChain( + startClass: ts.ClassDeclaration, + methodName: string + ): ts.MethodDeclaration | undefined { + // Prevent infinite loops from circular extends + const visited = new Set(); + let current: ts.ClassDeclaration | undefined = startClass; + while (current && !visited.has(current)) { + visited.add(current); + const found = current.members.find((m) => { + return ( + ts.isMethodDeclaration(m) && + ts.isIdentifier(m.name) && + m.name.text === methodName && + TsUtils.hasModifier(m.modifiers, ts.SyntaxKind.AbstractKeyword) + ); + }) as ts.MethodDeclaration | undefined; + if (found) { + return found; + } + current = this.getBaseClassDeclFromHeritageClause(current.heritageClauses); + } + return undefined; + } + + getBaseClassDeclFromHeritageClause(clauses?: ts.NodeArray): ts.ClassDeclaration | undefined { + if (!clauses) { + return undefined; + } + + const ext = clauses.find((h) => { + return h.token === ts.SyntaxKind.ExtendsKeyword; + }); + if (!ext || ext.types.length === 0) { + return undefined; + } + + // Resolve the base-class declaration + const expr = ext.types[0].expression; + if (!ts.isIdentifier(expr)) { + return undefined; + } + + const sym = this.tsUtils.trueSymbolAtLocation(expr); + return sym?.declarations?.find(ts.isClassDeclaration); + } + /** * Checks for missing super() call in child classes that extend a parent class * with parameterized constructors. If parent class only has parameterized constructors diff --git a/ets2panda/linter/test/main/distinct_abstract_method_default_return_type.ets b/ets2panda/linter/test/main/distinct_abstract_method_default_return_type.ets new file mode 100644 index 0000000000000000000000000000000000000000..95dd7d9c2873cde34ff08d8ac8a99a463e822fcb --- /dev/null +++ b/ets2panda/linter/test/main/distinct_abstract_method_default_return_type.ets @@ -0,0 +1,96 @@ +/* + * Copyright (c) 2025 Huawei Device Co., Ltd. + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +// ─────────────────────────────────────────────────────────────────────────── +// CASE 1: Simple override, no explicit type, non-async → OK +// Base has abstract foo() (no annotation), override without annotation defaults to void +abstract class A1 { + abstract foo(); +} +class B1 extends A1 { + foo() { // ✅ no error + // … + } +} + +// ─────────────────────────────────────────────────────────────────────────── +// CASE 2: Explicit void override → OK +abstract class A2 { + abstract foo(); +} +class B2 extends A2 { + foo(): void { // ✅ no error + // … + } +} + +// ─────────────────────────────────────────────────────────────────────────── +// CASE 3: Non-void override → ERROR +abstract class A3 { + abstract foo(); +} +class B3 extends A3 { + foo(): number { // ❌ should flag AbstractOverrideReturnTypeNotVoid + return 42; + } +} + +// ─────────────────────────────────────────────────────────────────────────── +// CASE 4: Async override without annotation → ERROR +// async methods default to Promise, and base foo() had no type +abstract class A4 { + abstract foo(); +} +class B4 extends A4 { + async foo() { // ❌ should flag AbstractOverrideReturnTypeNotVoid + await Promise.resolve(); + } +} + +// ─────────────────────────────────────────────────────────────────────────── +// CASE 5: Indirect inheritance through an intermediate class +abstract class A5 { + abstract foo(); +} +class B5 extends A5 { /* no override here */ } +class C5 extends B5 { + foo(): number { // ❌ should flag — walks up to A5 + return 1; + } +} + +// ─────────────────────────────────────────────────────────────────────────── +// CASE 6: Base declares a return type +abstract class A6 { + abstract bar(): string; // explicit annotation +} +class B6 extends A6 { + bar() { // ✅ no error (base had annotation) + return "ok"; + } +} +class C6 extends A6 { + bar(): number { // ✅ no InvalidAbstractOverrideReturnType error (this rule only applies when base had no type and derived method's type is different from void) + return 123; + } +} + +// ─────────────────────────────────────────────────────────────────────────── +// CASE 7: Class with its own non-override method — no error +class OwnClass { + fooOwn() { // ✅ no error + return 'own'; + } +} diff --git a/ets2panda/linter/test/main/distinct_abstract_method_default_return_type.ets.args.json b/ets2panda/linter/test/main/distinct_abstract_method_default_return_type.ets.args.json new file mode 100644 index 0000000000000000000000000000000000000000..bc4d2071daf6e9354e711c3b74b6be2b56659066 --- /dev/null +++ b/ets2panda/linter/test/main/distinct_abstract_method_default_return_type.ets.args.json @@ -0,0 +1,19 @@ +{ + "copyright": [ + "Copyright (c) 2025 Huawei Device Co., Ltd.", + "Licensed under the Apache License, Version 2.0 (the 'License');", + "you may not use this file except in compliance with the License.", + "You may obtain a copy of the License at", + "", + "http://www.apache.org/licenses/LICENSE-2.0", + "", + "Unless required by applicable law or agreed to in writing, software", + "distributed under the License is distributed on an 'AS IS' BASIS,", + "WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.", + "See the License for the specific language governing permissions and", + "limitations under the License." + ], + "mode": { + "arkts2": "" + } +} diff --git a/ets2panda/linter/test/main/distinct_abstract_method_default_return_type.ets.arkts2.json b/ets2panda/linter/test/main/distinct_abstract_method_default_return_type.ets.arkts2.json new file mode 100644 index 0000000000000000000000000000000000000000..82d3a8851c2eef3a7883e03f507415a517348a4d --- /dev/null +++ b/ets2panda/linter/test/main/distinct_abstract_method_default_return_type.ets.arkts2.json @@ -0,0 +1,88 @@ +{ + "copyright": [ + "Copyright (c) 2025 Huawei Device Co., Ltd.", + "Licensed under the Apache License, Version 2.0 (the 'License');", + "you may not use this file except in compliance with the License.", + "You may obtain a copy of the License at", + "", + "http://www.apache.org/licenses/LICENSE-2.0", + "", + "Unless required by applicable law or agreed to in writing, software", + "distributed under the License is distributed on an 'AS IS' BASIS,", + "WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.", + "See the License for the specific language governing permissions and", + "limitations under the License." + ], + "result": [ + { + "line": 23, + "column": 3, + "endLine": 23, + "endColumn": 6, + "problem": "MethodInheritRule", + "suggest": "", + "rule": "Overridden method parameters and return types must respect type inheritance principles (arkts-method-inherit-rule)", + "severity": "ERROR" + }, + { + "line": 34, + "column": 10, + "endLine": 34, + "endColumn": 14, + "problem": "MethodInheritRule", + "suggest": "", + "rule": "Overridden method parameters and return types must respect type inheritance principles (arkts-method-inherit-rule)", + "severity": "ERROR" + }, + { + "line": 45, + "column": 3, + "endLine": 45, + "endColumn": 6, + "problem": "InvalidAbstractOverrideReturnType", + "suggest": "", + "rule": "In 1.1, the default type obtained for the abstract method without the annotation type is any. In 1.2, the default type for the abstract method without the annotation type is void. (arkts-distinct-abstract-method-default-return-type)", + "severity": "ERROR" + }, + { + "line": 57, + "column": 9, + "endLine": 57, + "endColumn": 12, + "problem": "MethodInheritRule", + "suggest": "", + "rule": "Overridden method parameters and return types must respect type inheritance principles (arkts-method-inherit-rule)", + "severity": "ERROR" + }, + { + "line": 57, + "column": 9, + "endLine": 57, + "endColumn": 12, + "problem": "InvalidAbstractOverrideReturnType", + "suggest": "", + "rule": "In 1.1, the default type obtained for the abstract method without the annotation type is any. In 1.2, the default type for the abstract method without the annotation type is void. (arkts-distinct-abstract-method-default-return-type)", + "severity": "ERROR" + }, + { + "line": 69, + "column": 3, + "endLine": 69, + "endColumn": 6, + "problem": "InvalidAbstractOverrideReturnType", + "suggest": "", + "rule": "In 1.1, the default type obtained for the abstract method without the annotation type is any. In 1.2, the default type for the abstract method without the annotation type is void. (arkts-distinct-abstract-method-default-return-type)", + "severity": "ERROR" + }, + { + "line": 85, + "column": 10, + "endLine": 85, + "endColumn": 16, + "problem": "MethodInheritRule", + "suggest": "", + "rule": "Overridden method parameters and return types must respect type inheritance principles (arkts-method-inherit-rule)", + "severity": "ERROR" + } + ] +} diff --git a/ets2panda/linter/test/main/distinct_abstract_method_default_return_type.ets.json b/ets2panda/linter/test/main/distinct_abstract_method_default_return_type.ets.json new file mode 100644 index 0000000000000000000000000000000000000000..ca88f857e960b437dcf767c0ac40be998c8f1236 --- /dev/null +++ b/ets2panda/linter/test/main/distinct_abstract_method_default_return_type.ets.json @@ -0,0 +1,17 @@ +{ + "copyright": [ + "Copyright (c) 2025 Huawei Device Co., Ltd.", + "Licensed under the Apache License, Version 2.0 (the 'License');", + "you may not use this file except in compliance with the License.", + "You may obtain a copy of the License at", + "", + "http://www.apache.org/licenses/LICENSE-2.0", + "", + "Unless required by applicable law or agreed to in writing, software", + "distributed under the License is distributed on an 'AS IS' BASIS,", + "WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.", + "See the License for the specific language governing permissions and", + "limitations under the License." + ], + "result": [] +} \ No newline at end of file diff --git a/ets2panda/linter/test/main/method_inheritance.ets.arkts2.json b/ets2panda/linter/test/main/method_inheritance.ets.arkts2.json index 54216cf950e4b8b95c35c27f168c22a3f0131ae7..820ca0305bd2831849df8d8735ba4e66e820f3b2 100644 --- a/ets2panda/linter/test/main/method_inheritance.ets.arkts2.json +++ b/ets2panda/linter/test/main/method_inheritance.ets.arkts2.json @@ -244,6 +244,16 @@ "rule": "Overridden method parameters and return types must respect type inheritance principles (arkts-method-inherit-rule)", "severity": "ERROR" }, + { + "line": 266, + "column": 9, + "endLine": 266, + "endColumn": 12, + "problem": "InvalidAbstractOverrideReturnType", + "suggest": "", + "rule": "In 1.1, the default type obtained for the abstract method without the annotation type is any. In 1.2, the default type for the abstract method without the annotation type is void. (arkts-distinct-abstract-method-default-return-type)", + "severity": "ERROR" + }, { "line": 271, "column": 9, @@ -254,6 +264,16 @@ "rule": "Overridden method parameters and return types must respect type inheritance principles (arkts-method-inherit-rule)", "severity": "ERROR" }, + { + "line": 271, + "column": 9, + "endLine": 271, + "endColumn": 12, + "problem": "InvalidAbstractOverrideReturnType", + "suggest": "", + "rule": "In 1.1, the default type obtained for the abstract method without the annotation type is any. In 1.2, the default type for the abstract method without the annotation type is void. (arkts-distinct-abstract-method-default-return-type)", + "severity": "ERROR" + }, { "line": 277, "column": 15, @@ -264,6 +284,16 @@ "rule": "Overridden method parameters and return types must respect type inheritance principles (arkts-method-inherit-rule)", "severity": "ERROR" }, + { + "line": 277, + "column": 9, + "endLine": 277, + "endColumn": 12, + "problem": "InvalidAbstractOverrideReturnType", + "suggest": "", + "rule": "In 1.1, the default type obtained for the abstract method without the annotation type is any. In 1.2, the default type for the abstract method without the annotation type is void. (arkts-distinct-abstract-method-default-return-type)", + "severity": "ERROR" + }, { "line": 282, "column": 15, @@ -274,6 +304,16 @@ "rule": "Overridden method parameters and return types must respect type inheritance principles (arkts-method-inherit-rule)", "severity": "ERROR" }, + { + "line": 282, + "column": 9, + "endLine": 282, + "endColumn": 12, + "problem": "InvalidAbstractOverrideReturnType", + "suggest": "", + "rule": "In 1.1, the default type obtained for the abstract method without the annotation type is any. In 1.2, the default type for the abstract method without the annotation type is void. (arkts-distinct-abstract-method-default-return-type)", + "severity": "ERROR" + }, { "line": 287, "column": 15, @@ -284,6 +324,16 @@ "rule": "Overridden method parameters and return types must respect type inheritance principles (arkts-method-inherit-rule)", "severity": "ERROR" }, + { + "line": 287, + "column": 9, + "endLine": 287, + "endColumn": 12, + "problem": "InvalidAbstractOverrideReturnType", + "suggest": "", + "rule": "In 1.1, the default type obtained for the abstract method without the annotation type is any. In 1.2, the default type for the abstract method without the annotation type is void. (arkts-distinct-abstract-method-default-return-type)", + "severity": "ERROR" + }, { "line": 292, "column": 15, @@ -294,6 +344,16 @@ "rule": "Overridden method parameters and return types must respect type inheritance principles (arkts-method-inherit-rule)", "severity": "ERROR" }, + { + "line": 292, + "column": 9, + "endLine": 292, + "endColumn": 12, + "problem": "InvalidAbstractOverrideReturnType", + "suggest": "", + "rule": "In 1.1, the default type obtained for the abstract method without the annotation type is any. In 1.2, the default type for the abstract method without the annotation type is void. (arkts-distinct-abstract-method-default-return-type)", + "severity": "ERROR" + }, { "line": 298, "column": 10, @@ -304,6 +364,16 @@ "rule": "Overridden method parameters and return types must respect type inheritance principles (arkts-method-inherit-rule)", "severity": "ERROR" }, + { + "line": 303, + "column": 3, + "endLine": 303, + "endColumn": 6, + "problem": "InvalidAbstractOverrideReturnType", + "suggest": "", + "rule": "In 1.1, the default type obtained for the abstract method without the annotation type is any. In 1.2, the default type for the abstract method without the annotation type is void. (arkts-distinct-abstract-method-default-return-type)", + "severity": "ERROR" + }, { "line": 309, "column": 3, @@ -445,4 +515,4 @@ "severity": "ERROR" } ] -} +} \ No newline at end of file