@rushstack/eslint-config 3.7.0 → 4.0.0

package/CHANGELOG.md

@@ -0,0 +1,570 @@
+# Change Log - @rushstack/eslint-config
+
+This log was last generated on Tue, 13 Aug 2024 18:17:05 GMT and should not be manually modified.
+
+## 4.0.0
+Tue, 13 Aug 2024 18:17:05 GMT
+
+### Breaking changes
+
+- [BREAKING CHANGE] Bump "@typescript-eslint/eslint-plugin" to "~8.1.0" and "@typescript-eslint/eslint-parser" to "~8.1.0". Due to these changes, node@>=17.0.0 and eslint@^8.57.0 are now required due to breaking changes in the newer rules set.
+
+## 3.7.1
+Sat, 27 Jul 2024 00:10:27 GMT
+
+### Patches
+
+- Include CHANGELOG.md in published releases again
+
+## 3.7.0
+Wed, 29 May 2024 00:10:52 GMT
+
+### Minor changes
+
+- Bump the `eslint-plugin-tsdoc` plugin.
+
+## 3.6.10
+Fri, 17 May 2024 00:10:40 GMT
+
+_Version update only_
+
+## 3.6.9
+Wed, 10 Apr 2024 21:59:39 GMT
+
+_Version update only_
+
+## 3.6.8
+Fri, 29 Mar 2024 05:46:41 GMT
+
+_Version update only_
+
+## 3.6.7
+Thu, 28 Mar 2024 18:11:12 GMT
+
+_Version update only_
+
+## 3.6.6
+Wed, 27 Mar 2024 19:47:21 GMT
+
+_Version update only_
+
+## 3.6.5
+Wed, 20 Mar 2024 02:09:14 GMT
+
+_Version update only_
+
+## 3.6.4
+Sat, 17 Feb 2024 06:24:35 GMT
+
+_Version update only_
+
+## 3.6.3
+Wed, 07 Feb 2024 01:11:18 GMT
+
+_Version update only_
+
+## 3.6.2
+Thu, 25 Jan 2024 23:03:57 GMT
+
+_Version update only_
+
+## 3.6.1
+Wed, 24 Jan 2024 07:38:34 GMT
+
+_Version update only_
+
+## 3.6.0
+Tue, 16 Jan 2024 18:30:10 GMT
+
+### Minor changes
+
+- Add support for TypeScript 5.3 with @typescript-eslint 6.19.x
+
+## 3.5.1
+Fri, 15 Dec 2023 01:10:06 GMT
+
+_Version update only_
+
+## 3.5.0
+Wed, 22 Nov 2023 01:45:18 GMT
+
+### Minor changes
+
+- Added eslint-bulk-suppressions to @rushstack/eslint-config dependencies, allowing it to be used in all projects that use rushstack's eslint-config
+
+## 3.4.1
+Sun, 01 Oct 2023 02:56:30 GMT
+
+_Version update only_
+
+## 3.4.0
+Tue, 26 Sep 2023 09:30:33 GMT
+
+### Minor changes
+
+- Add an optional patch which can be used to allow ESLint to extend configurations from packages that do not have the "eslint-config-" prefix
+
+## 3.3.4
+Fri, 15 Sep 2023 00:36:58 GMT
+
+_Version update only_
+
+## 3.3.3
+Tue, 08 Aug 2023 07:10:39 GMT
+
+_Version update only_
+
+## 3.3.2
+Thu, 15 Jun 2023 00:21:01 GMT
+
+_Version update only_
+
+## 3.3.1
+Wed, 07 Jun 2023 22:45:16 GMT
+
+_Version update only_
+
+## 3.3.0
+Mon, 22 May 2023 06:34:32 GMT
+
+### Minor changes
+
+- Upgrade the @typescript-eslint/* dependencies to ~5.59.2
+
+## 3.2.0
+Fri, 10 Feb 2023 01:18:50 GMT
+
+### Minor changes
+
+- Replace the @typescript-eslint/no-parameter-properties rule with the replacement rule (@typescript-eslint/parameter-properties).
+
+## 3.1.1
+Mon, 10 Oct 2022 15:23:44 GMT
+
+_Version update only_
+
+## 3.1.0
+Thu, 29 Sep 2022 07:13:06 GMT
+
+### Minor changes
+
+- Upgraded @typescript-eslint dependencies to 5.30.x to enable support for TypeScript 4.8
+
+## 3.0.1
+Thu, 15 Sep 2022 00:18:51 GMT
+
+_Version update only_
+
+## 3.0.0
+Wed, 03 Aug 2022 18:40:35 GMT
+
+### Breaking changes
+
+- Upgrade TypeScript dependency to 4.7. This package now requires a peerDependency on TypeScript >=4.7
+
+## 2.6.2
+Tue, 28 Jun 2022 00:23:32 GMT
+
+_Version update only_
+
+## 2.6.1
+Fri, 17 Jun 2022 00:16:18 GMT
+
+_Version update only_
+
+## 2.6.0
+Sat, 23 Apr 2022 02:13:06 GMT
+
+### Minor changes
+
+- Add support for TypeScript 4.6
+
+## 2.5.4
+Fri, 15 Apr 2022 00:12:36 GMT
+
+_Version update only_
+
+## 2.5.3
+Sat, 09 Apr 2022 02:24:26 GMT
+
+### Patches
+
+- Rename the "master" branch to "main".
+
+## 2.5.2
+Tue, 15 Mar 2022 19:15:53 GMT
+
+### Patches
+
+- Fix the path in the package.json "directory" field.
+
+## 2.5.1
+Mon, 27 Dec 2021 16:10:40 GMT
+
+### Patches
+
+- Re-enable eslint-plugin-promise rules which now support ESLint v8
+
+## 2.5.0
+Mon, 06 Dec 2021 16:08:32 GMT
+
+### Minor changes
+
+- Temporarily disable eslint-plugin-promise until ESLint v8 support is added (https://github.com/xjamundx/eslint-plugin-promise/issues/218)
+
+## 2.4.5
+Fri, 05 Nov 2021 15:09:18 GMT
+
+_Version update only_
+
+## 2.4.4
+Wed, 27 Oct 2021 00:08:15 GMT
+
+### Patches
+
+- Update the package.json repository field to include the directory property.
+
+## 2.4.3
+Wed, 13 Oct 2021 15:09:54 GMT
+
+_Version update only_
+
+## 2.4.2
+Thu, 07 Oct 2021 07:13:35 GMT
+
+### Patches
+
+- Update typescript-eslint to add support for TypeScript 4.4.
+
+## 2.4.1
+Thu, 23 Sep 2021 00:10:40 GMT
+
+_Version update only_
+
+## 2.4.0
+Mon, 12 Jul 2021 23:08:26 GMT
+
+### Minor changes
+
+- Upgrade @typescript-eslint/* packages to 4.28.0 (GitHub #2389)
+
+## 2.3.4
+Mon, 12 Apr 2021 15:10:28 GMT
+
+_Version update only_
+
+## 2.3.3
+Tue, 06 Apr 2021 15:14:22 GMT
+
+### Patches
+
+- Switch to range version specifier for Typescript experimental utils
+
+## 2.3.2
+Thu, 10 Dec 2020 23:25:49 GMT
+
+### Patches
+
+- Upgrade to TSDoc 0.12.24
+
+## 2.3.1
+Wed, 11 Nov 2020 01:08:58 GMT
+
+_Version update only_
+
+## 2.3.0
+Fri, 30 Oct 2020 06:38:38 GMT
+
+### Minor changes
+
+- Exclude *.d.ts from linting
+- Set "root"=true to prevent unintended loading of other ESLint config files found in parent folders (which may be outside the Git working directory)
+
+## 2.2.3
+Fri, 30 Oct 2020 00:10:14 GMT
+
+### Patches
+
+- Update the "modern-module-resolution" patch to support ESLint 7.8.0 and newer
+
+## 2.2.2
+Wed, 28 Oct 2020 01:18:03 GMT
+
+_Version update only_
+
+## 2.2.1
+Tue, 06 Oct 2020 00:24:06 GMT
+
+_Version update only_
+
+## 2.2.0
+Mon, 05 Oct 2020 22:36:57 GMT
+
+### Minor changes
+
+- Add a mixin to support @rushstack/eslint-plugin-packlets
+
+## 2.1.3
+Wed, 30 Sep 2020 18:39:17 GMT
+
+_Version update only_
+
+## 2.1.2
+Wed, 30 Sep 2020 06:53:53 GMT
+
+### Patches
+
+- Update README.md
+
+## 2.1.1
+Tue, 22 Sep 2020 05:45:56 GMT
+
+### Patches
+
+- Fix some missing files that were incorrectly excluded due to .npmignore
+
+## 2.1.0
+Tue, 22 Sep 2020 01:45:31 GMT
+
+### Minor changes
+
+- Relax the "typedef" rule so that type inference is now allowed for local variables, while still requiring explicit type declarations in other scopes
+
+## 2.0.0
+Tue, 22 Sep 2020 00:08:53 GMT
+
+### Breaking changes
+
+- (BREAKING CHANGE) The "@rushstack/eslint-config" entry point has been separated into 3 choices: "@rushstack/eslint-config/profile/node", "@rushstack/eslint-config/profile/node-trusted-tool", or "@rushstack/eslint-config/profile/web-app".  See the documentation for details.
+
+## 1.4.2
+Sat, 19 Sep 2020 04:37:26 GMT
+
+_Version update only_
+
+## 1.4.1
+Sat, 19 Sep 2020 03:33:06 GMT
+
+### Patches
+
+- Add a dependency on the new @rushstack/eslint-plugin-security
+
+## 1.4.0
+Fri, 18 Sep 2020 22:57:24 GMT
+
+### Minor changes
+
+- Remove the @typescript-eslint/array-type rule
+- Add *.spec.ts file extension for tests, since this is also a commonly used convention
+
+### Patches
+
+- Relax @typescript-eslint/no-use-before-define slightly
+
+## 1.3.0
+Thu, 27 Aug 2020 11:27:06 GMT
+
+### Minor changes
+
+- Enable the "@rushstack/hoist-jest-mock" lint rule to catch a common mistake when using Jest with Heft
+
+### Patches
+
+- Add an override to relax some lint rules for *.test.ts files, making unit tests easier to write
+
+## 1.2.1
+Mon, 24 Aug 2020 07:35:20 GMT
+
+_Version update only_
+
+## 1.2.0
+Sat, 22 Aug 2020 05:55:42 GMT
+
+### Minor changes
+
+- Replace the "@rushstack/no-null" rule with a more flexible rule "@rushstack/no-new-null" (GitHub #2017)
+
+## 1.1.0
+Mon, 17 Aug 2020 04:53:23 GMT
+
+### Minor changes
+
+- Reclassify many lint rules to report ESLint warnings rather than errors
+
+## 1.0.4
+Wed, 12 Aug 2020 00:10:06 GMT
+
+_Version update only_
+
+## 1.0.3
+Sat, 25 Jul 2020 01:38:03 GMT
+
+### Patches
+
+- Update README.md to add the missing file extension for .eslintrc.js
+
+## 1.0.2
+Thu, 25 Jun 2020 06:43:34 GMT
+
+### Patches
+
+- Enable variableDeclarationIgnoreFunction for the "@typescript-eslint/typedef" rule
+
+## 1.0.1
+Wed, 24 Jun 2020 09:50:48 GMT
+
+### Patches
+
+- Fix an issue with the published file set
+
+## 1.0.0
+Wed, 24 Jun 2020 09:04:28 GMT
+
+### Breaking changes
+
+- Upgrade to ESLint 7. Breaking change: patch-eslint6.js has been renamed to patch-eslint-resolver.js
+
+## 0.5.8
+Wed, 27 May 2020 05:15:10 GMT
+
+### Patches
+
+- Relax "max-lines" lint rule to 2,000 lines instead of 1,000 lines
+
+## 0.5.7
+Wed, 08 Apr 2020 04:07:33 GMT
+
+### Patches
+
+- Improve the error message text for the "ban-types" rule
+
+## 0.5.6
+Sat, 28 Mar 2020 00:37:16 GMT
+
+### Patches
+
+- Upgrade to eslint-plugin-tsdoc version 0.2.4
+
+## 0.5.5
+Wed, 18 Mar 2020 15:07:47 GMT
+
+_Version update only_
+
+## 0.5.4
+Tue, 21 Jan 2020 21:56:13 GMT
+
+### Patches
+
+- Upgrade eslint-plugin-tsdoc to enable comments in tsdoc.json and more efficient loading
+
+## 0.5.3
+Sun, 19 Jan 2020 02:26:53 GMT
+
+_Version update only_
+
+## 0.5.2
+Fri, 17 Jan 2020 01:08:23 GMT
+
+_Version update only_
+
+## 0.5.1
+Thu, 09 Jan 2020 06:44:13 GMT
+
+_Version update only_
+
+## 0.5.0
+Wed, 08 Jan 2020 00:11:31 GMT
+
+### Minor changes
+
+- Replace "no-restricted-syntax" rule with an equivalent rule "@rushstack/no-null"
+
+## 0.4.2
+Mon, 11 Nov 2019 16:07:56 GMT
+
+### Patches
+
+- Add eslint-plugin-tsdoc; update plugin versions
+
+## 0.4.1
+Tue, 22 Oct 2019 06:24:44 GMT
+
+### Patches
+
+- Update documentation
+
+## 0.4.0
+Tue, 15 Oct 2019 01:22:16 GMT
+
+### Minor changes
+
+- Rename `@microsoft/eslint-config-scalable-ts` to `@rushstack/eslint-config`
+
+### Patches
+
+- Upgraded ESLint plugin dependencies
+
+## 0.3.1
+Sun, 29 Sep 2019 23:56:29 GMT
+
+### Patches
+
+- Update repository URL
+
+## 0.3.0
+Wed, 04 Sep 2019 01:43:31 GMT
+
+### Minor changes
+
+- Fix an issue where the @typescript-eslint/array-type rule required a syntax that broke compatibility with TypeScript versions prior to 3.4
+
+## 0.2.3
+Tue, 03 Sep 2019 23:13:45 GMT
+
+### Patches
+
+- Upgrade to @typescript-eslint/eslint-plugin 2.1.0
+
+## 0.2.2
+Tue, 27 Aug 2019 01:48:45 GMT
+
+### Patches
+
+- Remove unused plugin reference
+
+## 0.2.1
+Tue, 27 Aug 2019 01:24:54 GMT
+
+### Patches
+
+- Replace "eslint-plugin-no-null" with a more lenient implementation that allows equality comparisons with "null"
+
+## 0.2.0
+Wed, 21 Aug 2019 21:56:59 GMT
+
+### Minor changes
+
+- Enable react/no-deprecated, react/no-unescaped-entities, and react/self-closing-comp
+
+## 0.1.2
+Fri, 16 Aug 2019 21:58:15 GMT
+
+### Patches
+
+- Relax peer dependency to allow usage with ESLint 5
+
+## 0.1.1
+Fri, 16 Aug 2019 01:15:03 GMT
+
+### Patches
+
+- Fix an issue where @typescript-eslint/no-unused-vars didn't work properly with React source files
+- Relax @typescript-eslint/camelcase to allow "_checkBox1_onChanged"
+
+## 0.1.0
+Thu, 15 Aug 2019 02:56:10 GMT
+
+### Minor changes
+
+- Initial release
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rushstack/eslint-config",
-  "version": "3.7.0",
+  "version": "4.0.0",
   "description": "A TypeScript ESLint ruleset designed for large teams and projects",
   "license": "MIT",
   "repository": {
@@ -19,21 +19,21 @@
     "typescript"
   ],
   "peerDependencies": {
-    "eslint": "^6.0.0 || ^7.0.0 || ^8.0.0",
+    "eslint": "^8.57.0",
     "typescript": ">=4.7.0"
   },
   "dependencies": {
-    "@typescript-eslint/eslint-plugin": "~6.19.0",
-    "@typescript-eslint/utils": "~6.19.0",
-    "@typescript-eslint/parser": "~6.19.0",
-    "@typescript-eslint/typescript-estree": "~6.19.0",
+    "@typescript-eslint/eslint-plugin": "~8.1.0",
+    "@typescript-eslint/utils": "~8.1.0",
+    "@typescript-eslint/parser": "~8.1.0",
+    "@typescript-eslint/typescript-estree": "~8.1.0",
     "eslint-plugin-promise": "~6.1.1",
     "eslint-plugin-react": "~7.33.2",
     "eslint-plugin-tsdoc": "~0.3.0",
-    "@rushstack/eslint-patch": "1.10.3",
-    "@rushstack/eslint-plugin": "0.15.1",
-    "@rushstack/eslint-plugin-packlets": "0.9.1",
-    "@rushstack/eslint-plugin-security": "0.8.1"
+    "@rushstack/eslint-patch": "1.10.4",
+    "@rushstack/eslint-plugin-packlets": "0.9.2",
+    "@rushstack/eslint-plugin-security": "0.8.2",
+    "@rushstack/eslint-plugin": "0.15.2"
   },
   "devDependencies": {
     "eslint": "~8.57.0",

package/profile/_common.js

@@ -260,54 +260,10 @@ function buildRules(profile) {
           '@typescript-eslint/adjacent-overload-signatures': 'warn',
 
           // STANDARDIZED BY:   @typescript-eslint\eslint-plugin\dist\configs\recommended.json
-          //
-          // CONFIGURATION:     By default, these are banned: String, Boolean, Number, Object, Symbol
-          '@typescript-eslint/ban-types': [
-            'warn',
-            {
-              extendDefaults: false, // (the complete list is in this file)
-              types: {
-                String: {
-                  message: 'Use "string" instead',
-                  fixWith: 'string'
-                },
-                Boolean: {
-                  message: 'Use "boolean" instead',
-                  fixWith: 'boolean'
-                },
-                Number: {
-                  message: 'Use "number" instead',
-                  fixWith: 'number'
-                },
-                Object: {
-                  message: 'Use "object" instead, or else define a proper TypeScript type:'
-                },
-                Symbol: {
-                  message: 'Use "symbol" instead',
-                  fixWith: 'symbol'
-                },
-                Function: {
-                  message: [
-                    'The "Function" type accepts any function-like value.',
-                    'It provides no type safety when calling the function, which can be a common source of bugs.',
-                    'It also accepts things like class declarations, which will throw at runtime as they will not be called with "new".',
-                    'If you are expecting the function to accept certain arguments, you should explicitly define the function shape.'
-                  ].join('\n')
-                }
-
-                // This is a good idea, but before enabling it we need to put some thought into the recommended
-                // coding practices; the default suggestions are too vague.
-                //
-                // '{}': {
-                //   message: [
-                //     '"{}" actually means "any non-nullish value".',
-                //     '- If you want a type meaning "any object", you probably want "Record<string, unknown>" instead.',
-                //     '- If you want a type meaning "any value", you probably want "unknown" instead.'
-                //   ].join('\n')
-                // }
-              }
-            }
-          ],
+          '@typescript-eslint/no-unsafe-function-type': 'warn',
+
+          // STANDARDIZED BY:   @typescript-eslint\eslint-plugin\dist\configs\recommended.json
+          '@typescript-eslint/no-wrapper-object-types': 'warn',
 
           // RATIONALE:         We require "x as number" instead of "<number>x" to avoid conflicts with JSX.
           '@typescript-eslint/consistent-type-assertions': 'warn',
@@ -433,7 +389,9 @@ function buildRules(profile) {
               // Unused function arguments often indicate a mistake in JavaScript code.  However in TypeScript code,
               // the compiler catches most of those mistakes, and unused arguments are fairly common for type signatures
               // that are overriding a base class method or implementing an interface.
-              args: 'none'
+              args: 'none',
+              // Unused error arguments are common and useful for inspection when a debugger is attached.
+              caughtErrors: 'none'
             }
           ],