@typescript-eslint/eslint-plugin 8.62.2-alpha.11 → 8.62.2-alpha.12

package/dist/rules/method-signature-style.d.ts

@@ -1,5 +1,5 @@
 export type Options = [('method' | 'property')?];
-export type MessageIds = 'errorMethod' | 'errorProperty';
+export type MessageIds = 'convertToMethodSignature' | 'errorMethod' | 'errorProperty';
 declare const _default: import("@typescript-eslint/utils/ts-eslint").RuleModule<MessageIds, Options, import("../../rules").ESLintPluginDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener> & {
     name: string;
 };

package/dist/rules/method-signature-style.js

@@ -10,7 +10,9 @@ exports.default = (0, util_1.createRule)({
             description: 'Enforce using a particular method signature syntax',
         },
         fixable: 'code',
+        hasSuggestions: true,
         messages: {
+            convertToMethodSignature: 'Convert to a method signature. This removes the `readonly` modifier, allowing the member to be reassigned.',
             errorMethod: 'Shorthand method signature is forbidden. Use a function property instead.',
             errorProperty: 'Function property signature is forbidden. Use a method shorthand instead.',
         },
@@ -32,9 +34,6 @@ exports.default = (0, util_1.createRule)({
             if (node.optional) {
                 key = `${key}?`;
             }
-            if (node.readonly) {
-                key = `readonly ${key}`;
-            }
             return key;
         }
         function getMethodParams(node) {
@@ -164,16 +163,30 @@ exports.default = (0, util_1.createRule)({
                     if (typeNode?.type !== utils_1.AST_NODE_TYPES.TSFunctionType) {
                         return;
                     }
+                    const fix = fixer => {
+                        const key = getMethodKey(propertyNode);
+                        const params = getMethodParams(typeNode);
+                        const returnType = getMethodReturnType(typeNode);
+                        const delimiter = getDelimiter(propertyNode);
+                        return fixer.replaceText(propertyNode, `${key}${params}: ${returnType}${delimiter}`);
+                    };
+                    // There is no syntax for a `readonly` method signature, so converting
+                    // a `readonly` function-typed property drops the `readonly` modifier.
+                    // That is a behavioral change (a method may be reassigned, a
+                    // `readonly` property may not), so it is offered as a suggestion
+                    // rather than applied as an autofix.
+                    if (propertyNode.readonly) {
+                        context.report({
+                            node: propertyNode,
+                            messageId: 'errorProperty',
+                            suggest: [{ messageId: 'convertToMethodSignature', fix }],
+                        });
+                        return;
+                    }
                     context.report({
                         node: propertyNode,
                         messageId: 'errorProperty',
-                        fix: fixer => {
-                            const key = getMethodKey(propertyNode);
-                            const params = getMethodParams(typeNode);
-                            const returnType = getMethodReturnType(typeNode);
-                            const delimiter = getDelimiter(propertyNode);
-                            return fixer.replaceText(propertyNode, `${key}${params}: ${returnType}${delimiter}`);
-                        },
+                        fix,
                     });
                 },
             }),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typescript-eslint/eslint-plugin",
-  "version": "8.62.2-alpha.11",
+  "version": "8.62.2-alpha.12",
   "description": "TypeScript plugin for ESLint",
   "files": [
     "dist",
@@ -49,10 +49,10 @@
     "ignore": "^7.0.5",
     "natural-compare": "^1.4.0",
     "ts-api-utils": "^2.5.0",
-    "@typescript-eslint/scope-manager": "8.62.2-alpha.11",
-    "@typescript-eslint/type-utils": "8.62.2-alpha.11",
-    "@typescript-eslint/visitor-keys": "8.62.2-alpha.11",
-    "@typescript-eslint/utils": "8.62.2-alpha.11"
+    "@typescript-eslint/type-utils": "8.62.2-alpha.12",
+    "@typescript-eslint/scope-manager": "8.62.2-alpha.12",
+    "@typescript-eslint/visitor-keys": "8.62.2-alpha.12",
+    "@typescript-eslint/utils": "8.62.2-alpha.12"
   },
   "devDependencies": {
     "@types/json-schema": "^7.0.15",
@@ -76,13 +76,13 @@
     "typescript": ">=4.8.4 <6.1.0",
     "unist-util-visit": "^5.0.0",
     "vitest": "^4.0.18",
-    "@typescript-eslint/rule-schema-to-typescript-types": "8.62.2-alpha.11",
-    "@typescript-eslint/rule-tester": "8.62.2-alpha.11"
+    "@typescript-eslint/rule-schema-to-typescript-types": "8.62.2-alpha.12",
+    "@typescript-eslint/rule-tester": "8.62.2-alpha.12"
   },
   "peerDependencies": {
     "eslint": "^8.57.0 || ^9.0.0 || ^10.0.0",
     "typescript": ">=4.8.4 <6.1.0",
-    "@typescript-eslint/parser": "^8.62.2-alpha.11"
+    "@typescript-eslint/parser": "^8.62.2-alpha.12"
   },
   "funding": {
     "type": "opencollective",