eslint-plugin-complete 1.0.12 → 1.1.0

package/dist/rules/no-mutable-return.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"no-mutable-return.d.ts","sourceRoot":"","sources":["../../src/rules/no-mutable-return.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAMvD,KAAK,UAAU,GAAG,cAAc,GAAG,YAAY,GAAG,YAAY,CAAC;AAE/D,eAAO,MAAM,eAAe,wHAoD1B,CAAC"}
+{"version":3,"file":"no-mutable-return.d.ts","sourceRoot":"","sources":["../../src/rules/no-mutable-return.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAMvD,KAAK,UAAU,GAAG,cAAc,GAAG,YAAY,GAAG,YAAY,CAAC;AAE/D,eAAO,MAAM,eAAe,wHAsD1B,CAAC"}

package/dist/rules/no-mutable-return.js

@@ -1,6 +1,5 @@
-import { isTypeReferenceType } from "@typescript-eslint/type-utils";
 import { ESLintUtils } from "@typescript-eslint/utils";
-import { getTypeName, unionTypeParts } from "../typeUtils.js";
+import { getRealType, getTypeName, unionTypeParts } from "../typeUtils.js";
 import { createRule } from "../utils.js";
 export const noMutableReturn = createRule({
     name: "no-mutable-return",
@@ -28,7 +27,8 @@ export const noMutableReturn = createRule({
             const signatures = type.getCallSignatures();
             for (const signature of signatures) {
                 const returnType = signature.getReturnType();
-                for (const t of unionTypeParts(returnType)) {
+                const realReturnType = getRealType(parserServices.program, returnType);
+                for (const t of unionTypeParts(realReturnType)) {
                     const messageId = getErrorMessageId(t);
                     if (messageId !== undefined) {
                         context.report({
@@ -52,15 +52,6 @@ function getErrorMessageId(type) {
     if (typeName === undefined) {
         return undefined;
     }
-    // Handle unwrapping promises.
-    if (typeName === "Promise"
-        && isTypeReferenceType(type)
-        && type.typeArguments !== undefined) {
-        const typeArgument = type.typeArguments[0];
-        if (typeArgument !== undefined) {
-            return getErrorMessageId(typeArgument);
-        }
-    }
     // This would be "ReadonlyMap" if it was the read-only version.
     if (typeName === "Map") {
         return "mutableMap";

package/dist/rules/no-void-return-type.d.ts

@@ -1,2 +1,3 @@
-export declare const noVoidReturnType: import("@typescript-eslint/utils/ts-eslint").RuleModule<"voidReturnType", [], import("../interfaces/MyPluginDocs.js").MyPluginDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+import { ESLintUtils } from "@typescript-eslint/utils";
+export declare const noVoidReturnType: ESLintUtils.RuleModule<"voidReturnType", [], import("../interfaces/MyPluginDocs.js").MyPluginDocs, ESLintUtils.RuleListener>;
 //# sourceMappingURL=no-void-return-type.d.ts.map

package/dist/rules/no-void-return-type.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"no-void-return-type.d.ts","sourceRoot":"","sources":["../../src/rules/no-void-return-type.ts"],"names":[],"mappings":"AAGA,eAAO,MAAM,gBAAgB,gMAmD3B,CAAC"}
+{"version":3,"file":"no-void-return-type.d.ts","sourceRoot":"","sources":["../../src/rules/no-void-return-type.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkB,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAKvE,eAAO,MAAM,gBAAgB,8HAuD3B,CAAC"}

package/dist/rules/no-void-return-type.js

@@ -1,4 +1,5 @@
-import { AST_NODE_TYPES } from "@typescript-eslint/utils";
+import { AST_NODE_TYPES, ESLintUtils } from "@typescript-eslint/utils";
+import { getRealType, isVoid } from "../typeUtils.js";
 import { createRule } from "../utils.js";
 export const noVoidReturnType = createRule({
     name: "no-void-return-type",
@@ -7,7 +8,7 @@ export const noVoidReturnType = createRule({
         docs: {
             description: "Disallows `void` return types on non-exported functions",
             recommended: true,
-            requiresTypeChecking: false,
+            requiresTypeChecking: true,
         },
         schema: [],
         messages: {
@@ -17,6 +18,8 @@ export const noVoidReturnType = createRule({
     },
     defaultOptions: [],
     create(context) {
+        const parserServices = ESLintUtils.getParserServices(context);
+        const checker = parserServices.program.getTypeChecker();
         return {
             FunctionDeclaration(node) {
                 // Exported functions are exempt from this rule.
@@ -33,17 +36,22 @@ export const noVoidReturnType = createRule({
                     return;
                 }
                 const { typeAnnotation } = returnType;
-                if (typeAnnotation.type !== AST_NODE_TYPES.TSVoidKeyword) {
-                    return;
+                const tsNode = parserServices.esTreeNodeToTSNodeMap.get(typeAnnotation);
+                const type = checker.getTypeAtLocation(tsNode);
+                if (isVoidOrPromiseVoid(parserServices.program, type)) {
+                    context.report({
+                        loc: typeAnnotation.loc,
+                        messageId: "voidReturnType",
+                        fix(fixer) {
+                            return fixer.remove(returnType);
+                        },
+                    });
                 }
-                context.report({
-                    loc: typeAnnotation.loc,
-                    messageId: "voidReturnType",
-                    fix(fixer) {
-                        return fixer.remove(returnType);
-                    },
-                });
             },
         };
     },
 });
+function isVoidOrPromiseVoid(program, type) {
+    const realType = getRealType(program, type);
+    return isVoid(realType);
+}

package/dist/rules/prefer-readonly-parameter-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"prefer-readonly-parameter-types.d.ts","sourceRoot":"","sources":["../../src/rules/prefer-readonly-parameter-types.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAY1E,KAAK,OAAO,GAAG;IACb;QACE,KAAK,CAAC,EAAE,oBAAoB,EAAE,CAAC;QAC/B,wBAAwB,CAAC,EAAE,OAAO,CAAC;QACnC,mBAAmB,CAAC,EAAE,OAAO,CAAC;QAC9B,sBAAsB,CAAC,EAAE,OAAO,CAAC;QACjC,wBAAwB,CAAC,EAAE,OAAO,CAAC;KACpC;CACF,CAAC;AAGF,eAAO,MAAM,4BAA4B,6MA6MvC,CAAC"}
+{"version":3,"file":"prefer-readonly-parameter-types.d.ts","sourceRoot":"","sources":["../../src/rules/prefer-readonly-parameter-types.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,+BAA+B,CAAC;AAY1E,KAAK,OAAO,GAAG;IACb;QACE,KAAK,CAAC,EAAE,oBAAoB,EAAE,CAAC;QAC/B,wBAAwB,CAAC,EAAE,OAAO,CAAC;QACnC,mBAAmB,CAAC,EAAE,OAAO,CAAC;QAC9B,sBAAsB,CAAC,EAAE,OAAO,CAAC;QACjC,wBAAwB,CAAC,EAAE,OAAO,CAAC;KACpC;CACF,CAAC;AAGF,eAAO,MAAM,4BAA4B,6MA2MvC,CAAC"}

package/dist/rules/prefer-readonly-parameter-types.js

@@ -55,9 +55,7 @@ export const preferReadonlyParameterTypes = createRule({
     ],
     create(context, [{ allow, checkParameterProperties, ignoreInferredTypes, treatMethodsAsReadonly, onlyRecordsArraysMapsSet, },]) {
         const services = getParserServices(context);
-        if (allow === undefined) {
-            allow = [];
-        }
+        allow ??= [];
         allow.push("ReadonlyMap", "ReadonlySet");
         return {
             [[

package/dist/typeUtils.d.ts

@@ -1,4 +1,6 @@
 import ts from "typescript";
+/** If the type is a `Promise`, this will unwrap it. */
+export declare function getRealType(program: ts.Program, type: ts.Type): ts.Type;
 export declare function getTypeName(type: ts.Type): string | undefined;
 /**
  * @param symbol The symbol to check.
@@ -14,6 +16,7 @@ export declare function isSymbolFlagSet(symbol: ts.Symbol, flagsToCheck: number
  */
 export declare function isTypeArrayTupleTypeOrUnionOfArrayTupleTypes(type: ts.Type, checker: ts.TypeChecker): boolean;
 export declare function isAny(type: ts.Type): boolean;
+export declare function isVoid(type: ts.Type): boolean;
 /** Returns all types of a union type or an array containing `type` itself if it's no union type. */
 export declare function unionTypeParts(type: ts.Type): readonly ts.Type[];
 /**

package/dist/typeUtils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"typeUtils.d.ts","sourceRoot":"","sources":["../src/typeUtils.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,MAAM,YAAY,CAAC;AAW5B,wBAAgB,WAAW,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,MAAM,GAAG,SAAS,CAoB7D;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,EAAE,CAAC,MAAM,EACjB,YAAY,EAAE,MAAM,GAAG,EAAE,CAAC,WAAW,GACpC,OAAO,CAET;AAED;;;;;;GAMG;AACH,wBAAgB,4CAA4C,CAC1D,IAAI,EAAE,EAAE,CAAC,IAAI,EACb,OAAO,EAAE,EAAE,CAAC,WAAW,GACtB,OAAO,CAQT;AAED,wBAAgB,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,OAAO,CAE5C;AAED,oGAAoG;AACpG,wBAAgB,cAAc,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,SAAS,EAAE,CAAC,IAAI,EAAE,CAEhE;AAOD;;;;;;GAMG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,EAAE,CAAC,IAAI,EACb,YAAY,EAAE,MAAM,GAAG,EAAE,CAAC,SAAS,GAClC,OAAO,CAGT;AAED,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAE9D"}
+{"version":3,"file":"typeUtils.d.ts","sourceRoot":"","sources":["../src/typeUtils.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,MAAM,YAAY,CAAC;AAW5B,uDAAuD;AACvD,wBAAgB,WAAW,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,EAAE,CAAC,IAAI,CAavE;AAED,wBAAgB,WAAW,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,MAAM,GAAG,SAAS,CAoB7D;AAED;;;GAGG;AACH,wBAAgB,eAAe,CAC7B,MAAM,EAAE,EAAE,CAAC,MAAM,EACjB,YAAY,EAAE,MAAM,GAAG,EAAE,CAAC,WAAW,GACpC,OAAO,CAET;AAED;;;;;;GAMG;AACH,wBAAgB,4CAA4C,CAC1D,IAAI,EAAE,EAAE,CAAC,IAAI,EACb,OAAO,EAAE,EAAE,CAAC,WAAW,GACtB,OAAO,CAQT;AAED,wBAAgB,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,OAAO,CAE5C;AAED,wBAAgB,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,OAAO,CAE7C;AAED,oGAAoG;AACpG,wBAAgB,cAAc,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,GAAG,SAAS,EAAE,CAAC,IAAI,EAAE,CAEhE;AAOD;;;;;;GAMG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,EAAE,CAAC,IAAI,EACb,YAAY,EAAE,MAAM,GAAG,EAAE,CAAC,SAAS,GAClC,OAAO,CAGT;AAED,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAE9D"}

package/dist/typeUtils.js

@@ -1,5 +1,6 @@
 // Some of the functions are copy-pasted here from the `typescript-eslint` repository and slightly
 // modified.
+import { isPromiseLike, isTypeReferenceType, } from "@typescript-eslint/type-utils";
 import ts from "typescript";
 /** Gets all of the type flags in a type, iterating through unions automatically. */
 function getTypeFlags(type) {
@@ -9,6 +10,18 @@ function getTypeFlags(type) {
     }
     return flags;
 }
+/** If the type is a `Promise`, this will unwrap it. */
+export function getRealType(program, type) {
+    if (isPromiseLike(program, type)
+        && isTypeReferenceType(type)
+        && type.typeArguments !== undefined) {
+        const typeArgument = type.typeArguments[0];
+        if (typeArgument !== undefined) {
+            return typeArgument;
+        }
+    }
+    return type;
+}
 export function getTypeName(type) {
     const escapedName = type.getSymbol()?.escapedName;
     if (escapedName !== undefined && escapedName !== "__type") {
@@ -52,6 +65,9 @@ export function isTypeArrayTupleTypeOrUnionOfArrayTupleTypes(type, checker) {
 export function isAny(type) {
     return isTypeFlagSet(type, ts.TypeFlags.Any);
 }
+export function isVoid(type) {
+    return isTypeFlagSet(type, ts.TypeFlags.Void);
+}
 /** Returns all types of a union type or an array containing `type` itself if it's no union type. */
 export function unionTypeParts(type) {
     return isUnion(type) ? type.types : [type];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "eslint-plugin-complete",
-  "version": "1.0.12",
+  "version": "1.1.0",
   "description": "An ESLint plugin that contains useful rules.",
   "keywords": [
     "eslint",
@@ -44,23 +44,23 @@
     "test": "jest"
   },
   "dependencies": {
-    "@typescript-eslint/type-utils": "8.26.0",
-    "@typescript-eslint/utils": "8.26.0",
-    "typescript-eslint": "8.26.0"
+    "@typescript-eslint/type-utils": "8.34.1",
+    "@typescript-eslint/utils": "8.34.1",
+    "typescript-eslint": "8.34.1"
   },
   "devDependencies": {
-    "@babel/core": "7.26.9",
-    "@babel/preset-env": "7.26.9",
-    "@babel/preset-typescript": "7.26.0",
-    "@types/jest": "29.5.14",
-    "@types/node": "22.13.9",
-    "@typescript-eslint/rule-tester": "8.26.0",
-    "@typescript-eslint/types": "8.26.0",
-    "complete-common": "1.3.0",
-    "complete-node": "5.1.1",
-    "jest": "29.7.0",
+    "@babel/core": "7.27.4",
+    "@babel/preset-env": "7.27.2",
+    "@babel/preset-typescript": "7.27.1",
+    "@types/jest": "30.0.0",
+    "@types/node": "24.0.3",
+    "@typescript-eslint/rule-tester": "8.34.1",
+    "@typescript-eslint/types": "8.34.1",
+    "complete-common": "2.2.0",
+    "complete-node": "5.1.6",
+    "jest": "30.0.2",
     "prettier": "3.5.3",
-    "typescript": "5.8.2"
+    "typescript": "5.8.3"
   },
   "peerDependencies": {
     "eslint": ">= 9.0.0",