@typescript-eslint/eslint-plugin 7.0.0-alpha.0 → 7.0.1

package/docs/rules/typedef.md

@@ -67,14 +67,14 @@ Examples of code with `{ "arrayDestructuring": true }`:
 
 #### ❌ Incorrect
 
-```ts
+```ts option='{ "arrayDestructuring": true }'
 const [a] = [1];
 const [b, c] = [1, 2];
 ```
 
 #### ✅ Correct
 
-```ts
+```ts option='{ "arrayDestructuring": true }'
 const [a]: number[] = [1];
 const [b]: [number] = [2];
 const [c, d]: [boolean, string] = [true, 'text'];
@@ -93,7 +93,7 @@ Examples of code with `{ "arrowParameter": true }`:
 
 #### ❌ Incorrect
 
-```ts
+```ts option='{ "arrowParameter": true }'
 const logsSize = size => console.log(size);
 
 ['hello', 'world'].map(text => text.length);
@@ -105,7 +105,7 @@ const mapper = {
 
 #### ✅ Correct
 
-```ts
+```ts option='{ "arrowParameter": true }'
 const logsSize = (size: number) => console.log(size);
 
 ['hello', 'world'].map((text: string) => text.length);
@@ -125,7 +125,7 @@ Examples of code with `{ "memberVariableDeclaration": true }`:
 
 #### ❌ Incorrect
 
-```ts
+```ts option='{ "memberVariableDeclaration": true }'
 class ContainsText {
   delayedText;
   immediateTextImplicit = 'text';
@@ -134,7 +134,7 @@ class ContainsText {
 
 #### ✅ Correct
 
-```ts
+```ts option='{ "memberVariableDeclaration": true }'
 class ContainsText {
   delayedText: string;
   immediateTextImplicit: string = 'text';
@@ -151,14 +151,14 @@ Examples of code with `{ "objectDestructuring": true }`:
 
 #### ❌ Incorrect
 
-```ts
+```ts option='{ "objectDestructuring": true }'
 const { length } = 'text';
 const [b, c] = Math.random() ? [1, 2] : [3, 4];
 ```
 
 #### ✅ Correct
 
-```ts
+```ts option='{ "objectDestructuring": true }'
 const { length }: { length: number } = 'text';
 const [b, c]: [number, number] = Math.random() ? [1, 2] : [3, 4];
 
@@ -176,7 +176,7 @@ Examples of code with `{ "parameter": true }`:
 
 #### ❌ Incorrect
 
-```ts
+```ts option='{ "parameter": true }'
 function logsSize(size): void {
   console.log(size);
 }
@@ -204,7 +204,7 @@ class Logger {
 
 #### ✅ Correct
 
-```ts
+```ts option='{ "parameter": true }'
 function logsSize(size: number): void {
   console.log(size);
 }
@@ -240,7 +240,7 @@ Examples of code with `{ "propertyDeclaration": true }`:
 
 #### ❌ Incorrect
 
-```ts
+```ts option='{ "propertyDeclaration": true }'
 type Members = {
   member;
   otherMember;
@@ -249,7 +249,7 @@ type Members = {
 
 #### ✅ Correct
 
-```ts
+```ts option='{ "propertyDeclaration": true }'
 type Members = {
   member: boolean;
   otherMember: string;
@@ -266,7 +266,7 @@ Examples of code with `{ "variableDeclaration": true }`:
 
 #### ❌ Incorrect
 
-```ts
+```ts option='{ "variableDeclaration": true }'
 const text = 'text';
 let initialText = 'text';
 let delayedText;
@@ -274,7 +274,7 @@ let delayedText;
 
 #### ✅ Correct
 
-```ts
+```ts option='{ "variableDeclaration": true }'
 const text: string = 'text';
 let initialText: string = 'text';
 let delayedText: string;
@@ -290,21 +290,21 @@ Examples of code with `{ "variableDeclaration": true, "variableDeclarationIgnore
 
 #### ❌ Incorrect
 
-```ts
+```ts option='{ "variableDeclaration": true, "variableDeclarationIgnoreFunction": true }'
 const text = 'text';
 ```
 
 #### ✅ Correct
 
-```ts
+```ts option='{ "variableDeclaration": true, "variableDeclarationIgnoreFunction": true }'
 const a = (): void => {};
-const b = function (): void => {};
+const b = function (): void {};
 const c: () => void = (): void => {};
 
 class Foo {
   a = (): void => {};
-  b = function (): void => {};
-  c = () => void = (): void => {};
+  b = function (): void {};
+  c: () => void = (): void => {};
 }
 ```
 

package/docs/rules/unbound-method.md

@@ -83,7 +83,7 @@ const { double } = arith;
 
 Examples of **correct** code for this rule with `{ ignoreStatic: true }`:
 
-```ts
+```ts option='{ "ignoreStatic": true }' showPlaygroundButton
 class OtherClass {
   static log() {
     console.log(OtherClass);
@@ -98,6 +98,8 @@ log();
 
 ## When Not To Use It
 
-If your code intentionally waits to bind methods after use, such as by passing a `scope: this` along with the method, you can disable this rule.
+If your project dynamically changes `this` scopes around in a way TypeScript has difficulties modeling, this rule may not be viable to use.
+One likely difficult pattern is if your code intentionally waits to bind methods after use, such as by passing a `scope: this` along with the method.
+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.
 
 If you're wanting to use `toBeCalled` and similar matches in `jest` tests, you can disable this rule for your test files in favor of [`eslint-plugin-jest`'s version of this rule](https://github.com/jest-community/eslint-plugin-jest/blob/main/docs/rules/unbound-method.md).

package/docs/rules/unified-signatures.md

@@ -55,14 +55,23 @@ Examples of code for this rule with `ignoreDifferentlyNamedParameters`:
 
 ### ❌ Incorrect
 
-```ts
+```ts option='{ "ignoreDifferentlyNamedParameters": true }'
 function f(a: number): void;
 function f(a: string): void;
 ```
 
 ### ✅ Correct
 
-```ts
+```ts option='{ "ignoreDifferentlyNamedParameters": true }'
 function f(a: number): void;
 function f(b: string): void;
 ```
+
+## When Not To Use It
+
+This is purely a stylistic rule to help with readability of function signature overloads.
+You can turn it off if you don't want to consistently keep them next to each other and unified.
+
+## Related To
+
+- [`adjacent-overload-signatures`](./adjacent-overload-signatures.md)

package/index.d.ts

@@ -1,9 +1,13 @@
-import type { TSESLint } from '@typescript-eslint/utils';
+import type {
+  ClassicConfig,
+  FlatConfig,
+} from '@typescript-eslint/utils/ts-eslint';
 
 import type rules from './rules';
 
 declare const cjsExport: {
-  configs: Record<string, TSESLint.Linter.Config>;
+  configs: Record<string, ClassicConfig.Config>;
+  meta: FlatConfig.PluginMeta;
   rules: typeof rules;
 };
 export = cjsExport;

package/package.json

@@ -1,11 +1,12 @@
 {
   "name": "@typescript-eslint/eslint-plugin",
-  "version": "7.0.0-alpha.0+6ae1fa74b",
+  "version": "7.0.1",
   "description": "TypeScript plugin for ESLint",
   "files": [
     "dist",
     "docs",
     "index.d.ts",
+    "rules.d.ts",
     "package.json",
     "README.md",
     "LICENSE"
@@ -20,6 +21,10 @@
     "./use-at-your-own-risk/rules": {
       "types": "./rules.d.ts",
       "default": "./dist/rules/index.js"
+    },
+    "./use-at-your-own-risk/eslint-recommended-raw": {
+      "types": "./eslint-recommended-raw.d.ts",
+      "default": "./dist/configs/eslint-recommended-raw.js"
     }
   },
   "engines": {
@@ -48,47 +53,51 @@
     "postclean": "rimraf dist && rimraf coverage",
     "format": "prettier --write \"./**/*.{ts,mts,cts,tsx,js,mjs,cjs,jsx,json,md,css}\" --ignore-path ../../.prettierignore",
     "generate:breaking-changes": "yarn tsx tools/generate-breaking-changes.mts",
-    "generate:configs": "yarn tsx tools/generate-configs.ts",
-    "lint": "nx lint",
-    "test": "jest --coverage",
-    "test-single": "jest --no-coverage",
+    "generate:configs": "npx nx run repo-tools:generate-configs",
+    "lint": "npx nx lint",
+    "test": "cross-env NODE_OPTIONS=\"--experimental-vm-modules\" jest --coverage --logHeapUsage",
+    "test-single": "cross-env NODE_OPTIONS=\"--experimental-vm-modules\" jest --no-coverage",
     "typecheck": "tsc -p tsconfig.json --noEmit"
   },
   "dependencies": {
-    "@eslint-community/regexpp": "^4.5.0",
-    "@typescript-eslint/scope-manager": "7.0.0-alpha.0+6ae1fa74b",
-    "@typescript-eslint/type-utils": "7.0.0-alpha.0+6ae1fa74b",
-    "@typescript-eslint/utils": "7.0.0-alpha.0+6ae1fa74b",
-    "@typescript-eslint/visitor-keys": "7.0.0-alpha.0+6ae1fa74b",
+    "@eslint-community/regexpp": "^4.5.1",
+    "@typescript-eslint/scope-manager": "7.0.1",
+    "@typescript-eslint/type-utils": "7.0.1",
+    "@typescript-eslint/utils": "7.0.1",
+    "@typescript-eslint/visitor-keys": "7.0.1",
     "debug": "^4.3.4",
-    "grapheme-splitter": "^1.0.4",
     "graphemer": "^1.4.0",
     "ignore": "^5.2.4",
     "natural-compare": "^1.4.0",
-    "natural-compare-lite": "^1.4.0",
-    "semver": "^7.5.0",
+    "semver": "^7.5.4",
     "ts-api-utils": "^1.0.1"
   },
   "devDependencies": {
     "@types/debug": "*",
     "@types/marked": "*",
     "@types/natural-compare": "*",
-    "@types/prettier": "*",
-    "@typescript-eslint/rule-schema-to-typescript-types": "6.0.0",
-    "@typescript-eslint/rule-tester": "7.0.0-alpha.0+6ae1fa74b",
-    "chalk": "^5.0.1",
+    "@typescript-eslint/rule-schema-to-typescript-types": "7.0.1",
+    "@typescript-eslint/rule-tester": "7.0.1",
+    "ajv": "^6.12.6",
+    "chalk": "^5.3.0",
+    "cross-env": "^7.0.3",
     "cross-fetch": "*",
-    "jest-specific-snapshot": "*",
+    "eslint": "*",
+    "grapheme-splitter": "^1.0.4",
+    "jest": "29.7.0",
+    "jest-specific-snapshot": "^8.0.0",
     "json-schema": "*",
     "markdown-table": "^3.0.3",
-    "marked": "^4.3.0",
-    "prettier": "*",
+    "marked": "^5.1.1",
+    "prettier": "^3.0.3",
+    "rimraf": "*",
     "title-case": "^3.0.3",
+    "tsx": "*",
     "typescript": "*"
   },
   "peerDependencies": {
-    "@typescript-eslint/parser": "^6.0.0 || ^6.0.0-alpha",
-    "eslint": "^7.0.0 || ^8.0.0"
+    "@typescript-eslint/parser": "^7.0.0",
+    "eslint": "^8.56.0"
   },
   "peerDependenciesMeta": {
     "typescript": {
@@ -98,6 +107,5 @@
   "funding": {
     "type": "opencollective",
     "url": "https://opencollective.com/typescript-eslint"
-  },
-  "gitHead": "6ae1fa74b18af8a2d4baa0d3d4b43997cf9a9781"
+  }
 }

package/rules.d.ts

@@ -0,0 +1,46 @@
+/*
+We purposely don't generate types for our plugin because TL;DR:
+1) there's no real reason that anyone should do a typed import of our rules,
+2) it would require us to change our code so there aren't as many inferred types
+
+This type declaration exists as a hacky way to add a type to the export for our
+internal packages that require it.
+
+*** Long reason ***
+
+When you turn on declaration files, TS requires all types to be "fully resolvable"
+without changes to the code.
+All of our lint rules `export default createRule(...)`, which means they all
+implicitly reference the `TSESLint.Rule` type for the export.
+
+TS wants to transpile each rule file to this `.d.ts` file:
+
+```ts
+import type { TSESLint } from '@typescript-eslint/utils';
+declare const _default: TSESLint.RuleModule<TMessageIds, TOptions, TSESLint.RuleListener>;
+export default _default;
+```
+
+Because we don't import `TSESLint` in most files, it means that TS would have to
+insert a new import during the declaration emit to make this work.
+However TS wants to avoid adding new imports to the file because a new module
+could have type side-effects (like global augmentation) which could cause weird
+type side-effects in the decl file that wouldn't exist in source TS file.
+
+So TS errors on most of our rules with the following error:
+```
+The inferred type of 'default' cannot be named without a reference to
+'../../../../node_modules/@typescript-eslint/utils/src/ts-eslint/Rule'.
+This is likely not portable. A type annotation is necessary. ts(2742)
+```
+*/
+
+import type { RuleModule } from '@typescript-eslint/utils/ts-eslint';
+
+export type TypeScriptESLintRules = Record<
+  string,
+  RuleModule<string, unknown[]>
+>;
+declare const rules: TypeScriptESLintRules;
+// eslint-disable-next-line import/no-default-export
+export default rules;