@typescript-eslint/eslint-plugin 8.24.2-alpha.2 → 8.24.2-alpha.4

package/dist/rules/unified-signatures.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"unified-signatures.d.ts","sourceRoot":"","sources":["../../src/rules/unified-signatures.ts"],"names":[],"mappings":"AAuDA,MAAM,MAAM,UAAU,GAClB,uBAAuB,GACvB,yBAAyB,GACzB,2BAA2B,CAAC;AAEhC,MAAM,MAAM,OAAO,GAAG;IACpB;QACE,gCAAgC,CAAC,EAAE,OAAO,CAAC;KAC5C;CACF,CAAC;;AAEF,wBAugBG"}
+{"version":3,"file":"unified-signatures.d.ts","sourceRoot":"","sources":["../../src/rules/unified-signatures.ts"],"names":[],"mappings":"AAuDA,MAAM,MAAM,UAAU,GAClB,uBAAuB,GACvB,yBAAyB,GACzB,2BAA2B,CAAC;AAEhC,MAAM,MAAM,OAAO,GAAG;IACpB;QACE,gCAAgC,CAAC,EAAE,OAAO,CAAC;KAC5C;CACF,CAAC;;AAEF,wBA2gBG"}

package/dist/rules/unified-signatures.js

@@ -334,12 +334,12 @@ exports.default = (0, util_1.createRule)({
             TSTypeLiteral: createScope,
             // collect overloads
             MethodDefinition(node) {
-                if (!node.value.body) {
+                if (!node.value.body && !isGetterOrSetter(node)) {
                     addOverload(node);
                 }
             },
             TSAbstractMethodDefinition(node) {
-                if (!node.value.body) {
+                if (!node.value.body && !isGetterOrSetter(node)) {
                     addOverload(node);
                 }
             },
@@ -349,7 +349,11 @@ exports.default = (0, util_1.createRule)({
                 const exportingNode = getExportingNode(node);
                 addOverload(node, node.id?.name ?? exportingNode?.type, exportingNode);
             },
-            TSMethodSignature: addOverload,
+            TSMethodSignature(node) {
+                if (!isGetterOrSetter(node)) {
+                    addOverload(node);
+                }
+            },
             // validate scopes
             'ClassDeclaration:exit': checkScope,
             'Program:exit': checkScope,
@@ -396,3 +400,6 @@ function getStaticParameterName(param) {
 function isIdentifier(node) {
     return node.type === utils_1.AST_NODE_TYPES.Identifier;
 }
+function isGetterOrSetter(node) {
+    return node.kind === 'get' || node.kind === 'set';
+}

package/dist/util/hasOverloadSignatures.d.ts

@@ -0,0 +1,7 @@
+import type { TSESTree } from '@typescript-eslint/utils';
+import type { RuleContext } from '@typescript-eslint/utils/ts-eslint';
+/**
+ * @return `true` if the function or method node has overload signatures.
+ */
+export declare function hasOverloadSignatures(node: TSESTree.FunctionDeclaration | TSESTree.MethodDefinition, context: RuleContext<string, unknown[]>): boolean;
+//# sourceMappingURL=hasOverloadSignatures.d.ts.map

package/dist/util/hasOverloadSignatures.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hasOverloadSignatures.d.ts","sourceRoot":"","sources":["../../src/util/hasOverloadSignatures.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AACzD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AAMtE;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,IAAI,EAAE,QAAQ,CAAC,mBAAmB,GAAG,QAAQ,CAAC,gBAAgB,EAC9D,OAAO,EAAE,WAAW,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,GACtC,OAAO,CAqCT"}

package/dist/util/hasOverloadSignatures.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasOverloadSignatures = hasOverloadSignatures;
+const utils_1 = require("@typescript-eslint/utils");
+const misc_1 = require("./misc");
+/**
+ * @return `true` if the function or method node has overload signatures.
+ */
+function hasOverloadSignatures(node, context) {
+    // `export default function () {}`
+    if (node.parent.type === utils_1.AST_NODE_TYPES.ExportDefaultDeclaration) {
+        return node.parent.parent.body.some(member => {
+            return (member.type === utils_1.AST_NODE_TYPES.ExportDefaultDeclaration &&
+                member.declaration.type === utils_1.AST_NODE_TYPES.TSDeclareFunction);
+        });
+    }
+    // `export function f() {}`
+    if (node.parent.type === utils_1.AST_NODE_TYPES.ExportNamedDeclaration) {
+        return node.parent.parent.body.some(member => {
+            return (member.type === utils_1.AST_NODE_TYPES.ExportNamedDeclaration &&
+                member.declaration?.type === utils_1.AST_NODE_TYPES.TSDeclareFunction &&
+                getFunctionDeclarationName(member.declaration, context) ===
+                    getFunctionDeclarationName(node, context));
+        });
+    }
+    // either:
+    // - `function f() {}`
+    // - `class T { foo() {} }`
+    const nodeKey = getFunctionDeclarationName(node, context);
+    return node.parent.body.some(member => {
+        return ((member.type === utils_1.AST_NODE_TYPES.TSDeclareFunction ||
+            (member.type === utils_1.AST_NODE_TYPES.MethodDefinition &&
+                member.value.body == null)) &&
+            nodeKey === getFunctionDeclarationName(member, context));
+    });
+}
+function getFunctionDeclarationName(node, context) {
+    if (node.type === utils_1.AST_NODE_TYPES.FunctionDeclaration ||
+        node.type === utils_1.AST_NODE_TYPES.TSDeclareFunction) {
+        // For a `FunctionDeclaration` or `TSDeclareFunction` this may be `null` if
+        // and only if the parent is an `ExportDefaultDeclaration`.
+        //
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        return node.id.name;
+    }
+    return (0, misc_1.getStaticMemberAccessValue)(node, context);
+}

package/dist/util/index.d.ts

@@ -10,6 +10,7 @@ export * from './getStringLength';
 export * from './getTextWithParentheses';
 export * from './getThisExpression';
 export * from './getWrappingFixer';
+export * from './hasOverloadSignatures';
 export * from './isArrayMethodCallWithPredicate';
 export * from './isAssignee';
 export * from './isNodeEqual';
@@ -25,6 +26,7 @@ export * from './types';
 export * from './getConstraintInfo';
 export * from './getValueOfLiteralType';
 export * from './truthinessAndNullishUtils';
+export * from './skipChainExpression';
 export * from '@typescript-eslint/type-utils';
 export declare const applyDefault: typeof ESLintUtils.applyDefault, deepMerge: typeof ESLintUtils.deepMerge, getParserServices: typeof ESLintUtils.getParserServices, isObjectNotArray: typeof ESLintUtils.isObjectNotArray, nullThrows: typeof ESLintUtils.nullThrows, NullThrowsReasons: {
     readonly MissingParent: "Expected node to have a parent.";

package/dist/util/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/util/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,cAAc,YAAY,CAAC;AAC3B,cAAc,0BAA0B,CAAC;AACzC,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,kCAAkC,CAAC;AACjD,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,yBAAyB,CAAC;AACxC,cAAc,QAAQ,CAAC;AACvB,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAG5C,cAAc,+BAA+B,CAAC;AAE9C,eAAO,MACL,YAAY,mCACZ,SAAS,gCACT,iBAAiB,wCACjB,gBAAgB,uCAChB,UAAU,iCACV,iBAAiB;;;CACJ,CAAC;AAChB,MAAM,MAAM,2BAA2B,CAAC,CAAC,IACvC,WAAW,CAAC,2BAA2B,CAAC,CAAC,CAAC,CAAC;AAC7C,MAAM,MAAM,wBAAwB,CAAC,CAAC,IACpC,WAAW,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/util/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAEvD,cAAc,YAAY,CAAC;AAC3B,cAAc,0BAA0B,CAAC;AACzC,cAAc,cAAc,CAAC;AAC7B,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,wBAAwB,CAAC;AACvC,cAAc,mBAAmB,CAAC;AAClC,cAAc,0BAA0B,CAAC;AACzC,cAAc,qBAAqB,CAAC;AACpC,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC;AACxC,cAAc,kCAAkC,CAAC;AACjD,cAAc,cAAc,CAAC;AAC7B,cAAc,eAAe,CAAC;AAC9B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,yBAAyB,CAAC;AACxC,cAAc,QAAQ,CAAC;AACvB,cAAc,2BAA2B,CAAC;AAC1C,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,cAAc,CAAC;AAC7B,cAAc,SAAS,CAAC;AACxB,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,uBAAuB,CAAC;AAGtC,cAAc,+BAA+B,CAAC;AAE9C,eAAO,MACL,YAAY,mCACZ,SAAS,gCACT,iBAAiB,wCACjB,gBAAgB,uCAChB,UAAU,iCACV,iBAAiB;;;CACJ,CAAC;AAChB,MAAM,MAAM,2BAA2B,CAAC,CAAC,IACvC,WAAW,CAAC,2BAA2B,CAAC,CAAC,CAAC,CAAC;AAC7C,MAAM,MAAM,wBAAwB,CAAC,CAAC,IACpC,WAAW,CAAC,wBAAwB,CAAC,CAAC,CAAC,CAAC"}

package/dist/util/index.js

@@ -27,6 +27,7 @@ __exportStar(require("./getStringLength"), exports);
 __exportStar(require("./getTextWithParentheses"), exports);
 __exportStar(require("./getThisExpression"), exports);
 __exportStar(require("./getWrappingFixer"), exports);
+__exportStar(require("./hasOverloadSignatures"), exports);
 __exportStar(require("./isArrayMethodCallWithPredicate"), exports);
 __exportStar(require("./isAssignee"), exports);
 __exportStar(require("./isNodeEqual"), exports);
@@ -42,6 +43,7 @@ __exportStar(require("./types"), exports);
 __exportStar(require("./getConstraintInfo"), exports);
 __exportStar(require("./getValueOfLiteralType"), exports);
 __exportStar(require("./truthinessAndNullishUtils"), exports);
+__exportStar(require("./skipChainExpression"), exports);
 // this is done for convenience - saves migrating all of the old rules
 __exportStar(require("@typescript-eslint/type-utils"), exports);
 exports.applyDefault = utils_1.ESLintUtils.applyDefault, exports.deepMerge = utils_1.ESLintUtils.deepMerge, exports.getParserServices = utils_1.ESLintUtils.getParserServices, exports.isObjectNotArray = utils_1.ESLintUtils.isObjectNotArray, exports.nullThrows = utils_1.ESLintUtils.nullThrows, exports.NullThrowsReasons = utils_1.ESLintUtils.NullThrowsReasons;

package/dist/util/skipChainExpression.d.ts

@@ -0,0 +1,3 @@
+import type { TSESTree } from '@typescript-eslint/utils';
+export declare function skipChainExpression<T extends TSESTree.Node>(node: T): T | TSESTree.ChainElement;
+//# sourceMappingURL=skipChainExpression.d.ts.map

package/dist/util/skipChainExpression.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"skipChainExpression.d.ts","sourceRoot":"","sources":["../../src/util/skipChainExpression.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAIzD,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,QAAQ,CAAC,IAAI,EACzD,IAAI,EAAE,CAAC,GACN,CAAC,GAAG,QAAQ,CAAC,YAAY,CAE3B"}

package/dist/util/skipChainExpression.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.skipChainExpression = skipChainExpression;
+const utils_1 = require("@typescript-eslint/utils");
+function skipChainExpression(node) {
+    return node.type === utils_1.AST_NODE_TYPES.ChainExpression ? node.expression : node;
+}

package/docs/rules/consistent-type-definitions.mdx

@@ -82,13 +82,52 @@ type T = { x: number };
 </TabItem>
 </Tabs>
 
+## FAQs
+
+### What are the differences between `interface` and `type`?
+
+There are very few differences between interfaces and object types in TypeScript.
+Other than type aliases being used to represent union types, it is rare that you will need to choose one over the other.
+
+| Feature               | Interfaces | Object Types | Explanation                                                                                            |
+| --------------------- | ---------- | ------------ | ------------------------------------------------------------------------------------------------------ |
+| Object shapes         | ✅         | ✅           | Both can be used to represent general object shapes.                                                   |
+| General performance   | ✅         | ✅           | Both are optimized for performance in TypeScript's type checker.                                       |
+| Edge case performance | ✅         |              | Large, complex logical types can be optimized better with interfaces by TypeScript's type checker.     |
+| Traditional semantics | ✅         |              | Interfaces are typically the default in much -though not all- of the TypeScript community.             |
+| Non-object shapes     |            | ✅           | Object types may describe literals, primitives, unions, and intersections.                             |
+| Logical types         |            | ✅           | Object types may include conditional and mapped types.                                                 |
+| Merging               | Allowed    | Not allowed  | Interfaces of the same name are treated as one interface ("merged"); type aliases may not share names. |
+
+We recommend choosing one definition style, using it when possible, and falling back to the other style when needed.
+The benefits of remaining consistent within a codebase almost always outweigh the benefits of either definition style.
+
+### When do the performance differences between `interface` and `type` matter?
+
+Almost never.
+Most TypeScript projects do not -and should not- utilize types that exercise the performance differences between the two kinds of definitions.
+
+If you are having problems with type checking performance, see the [TypeScript Wiki's Performance page](https://github.com/microsoft/TypeScript/wiki/Performance).
+
+### Why is the default `interface`?
+
+Interfaces are the prevailing, most common style in the TypeScript.
+`interface` has traditionally been TypeScript's intended ("semantic") way to convey _"an object with these fields"_.
+
+We generally recommend staying with the default, `'interface'`, to be stylistically consistent with the majority of TypeScript projects.
+If you strongly prefer `'type'`, that's fine too.
+
 ## When Not To Use It
 
-If you specifically want to use an interface or type literal for stylistic reasons, you can avoid this rule.
+If you specifically want to manually choose whether to use an interface or type literal for stylistic reasons each time you define a type, you can avoid this rule.
 
 However, keep in mind that inconsistent style can harm readability in a project.
 We recommend picking a single option for this rule that works best for your project.
 
-There are also subtle differences between `Record` and `interface` that can be difficult to catch statically.
-For example, if your project is a dependency of another project that relies on a specific type definition style, this rule may be counterproductive.
-You might consider using [ESLint disable comments](https://eslint.org/docs/latest/use/configure/rules#using-configuration-comments-1) for those specific situations instead of completely disabling this rule.
+You might occasionally need to a different definition type in specific cases, such as if your project is a dependency or dependent of another project that relies on a specific type definition style.
+Consider using [ESLint disable comments](https://eslint.org/docs/latest/use/configure/rules#using-configuration-comments-1) for those specific situations instead of completely disabling this rule.
+
+## Further Reading
+
+- [TypeScript Handbook > Everyday Types > Differences Between Type Aliases and Interfaces](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#differences-between-type-aliases-and-interfaces)
+- [StackOverflow: Interfaces vs Types in TypeScript](https://stackoverflow.com/questions/37233735/interfaces-vs-types-in-typescript)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@typescript-eslint/eslint-plugin",
-  "version": "8.24.2-alpha.2",
+  "version": "8.24.2-alpha.4",
   "description": "TypeScript plugin for ESLint",
   "files": [
     "dist",
@@ -62,10 +62,10 @@
   },
   "dependencies": {
     "@eslint-community/regexpp": "^4.10.0",
-    "@typescript-eslint/scope-manager": "8.24.2-alpha.2",
-    "@typescript-eslint/type-utils": "8.24.2-alpha.2",
-    "@typescript-eslint/utils": "8.24.2-alpha.2",
-    "@typescript-eslint/visitor-keys": "8.24.2-alpha.2",
+    "@typescript-eslint/scope-manager": "8.24.2-alpha.4",
+    "@typescript-eslint/type-utils": "8.24.2-alpha.4",
+    "@typescript-eslint/utils": "8.24.2-alpha.4",
+    "@typescript-eslint/visitor-keys": "8.24.2-alpha.4",
     "graphemer": "^1.4.0",
     "ignore": "^5.3.1",
     "natural-compare": "^1.4.0",
@@ -76,8 +76,8 @@
     "@types/marked": "^5.0.2",
     "@types/mdast": "^4.0.3",
     "@types/natural-compare": "*",
-    "@typescript-eslint/rule-schema-to-typescript-types": "8.24.2-alpha.2",
-    "@typescript-eslint/rule-tester": "8.24.2-alpha.2",
+    "@typescript-eslint/rule-schema-to-typescript-types": "8.24.2-alpha.4",
+    "@typescript-eslint/rule-tester": "8.24.2-alpha.4",
     "ajv": "^6.12.6",
     "cross-env": "^7.0.3",
     "cross-fetch": "*",