[eslint-patch] Implementation for ESLint Bulk Suppressions v0.1.0

.gitignore

@@ -97,3 +97,4 @@ dist
 dist-storybook
 *.scss.ts
 *.sass.ts
+*.tsbuildinfo

README.md

@@ -55,6 +55,7 @@ These GitHub repositories provide supplementary resources for Rush Stack:
 | [/apps/rundown](./apps/rundown/) | [![npm version](https://badge.fury.io/js/%40rushstack%2Frundown.svg)](https://badge.fury.io/js/%40rushstack%2Frundown) | [changelog](./apps/rundown/CHANGELOG.md) | [@rushstack/rundown](https://www.npmjs.com/package/@rushstack/rundown) |
 | [/apps/rush](./apps/rush/) | [![npm version](https://badge.fury.io/js/%40microsoft%2Frush.svg)](https://badge.fury.io/js/%40microsoft%2Frush) | [changelog](./apps/rush/CHANGELOG.md) | [@microsoft/rush](https://www.npmjs.com/package/@microsoft/rush) |
 | [/apps/trace-import](./apps/trace-import/) | [![npm version](https://badge.fury.io/js/%40rushstack%2Ftrace-import.svg)](https://badge.fury.io/js/%40rushstack%2Ftrace-import) | [changelog](./apps/trace-import/CHANGELOG.md) | [@rushstack/trace-import](https://www.npmjs.com/package/@rushstack/trace-import) |
+| [/eslint/eslint-bulk](./eslint/eslint-bulk/) | [![npm version](https://badge.fury.io/js/%40rushstack%2Feslint-bulk.svg)](https://badge.fury.io/js/%40rushstack%2Feslint-bulk) | [changelog](./eslint/eslint-bulk/CHANGELOG.md) | [@rushstack/eslint-bulk](https://www.npmjs.com/package/@rushstack/eslint-bulk) |
 | [/eslint/eslint-config](./eslint/eslint-config/) | [![npm version](https://badge.fury.io/js/%40rushstack%2Feslint-config.svg)](https://badge.fury.io/js/%40rushstack%2Feslint-config) | [changelog](./eslint/eslint-config/CHANGELOG.md) | [@rushstack/eslint-config](https://www.npmjs.com/package/@rushstack/eslint-config) |
 | [/eslint/eslint-patch](./eslint/eslint-patch/) | [![npm version](https://badge.fury.io/js/%40rushstack%2Feslint-patch.svg)](https://badge.fury.io/js/%40rushstack%2Feslint-patch) | [changelog](./eslint/eslint-patch/CHANGELOG.md) | [@rushstack/eslint-patch](https://www.npmjs.com/package/@rushstack/eslint-patch) |
 | [/eslint/eslint-plugin](./eslint/eslint-plugin/) | [![npm version](https://badge.fury.io/js/%40rushstack%2Feslint-plugin.svg)](https://badge.fury.io/js/%40rushstack%2Feslint-plugin) | [changelog](./eslint/eslint-plugin/CHANGELOG.md) | [@rushstack/eslint-plugin](https://www.npmjs.com/package/@rushstack/eslint-plugin) |
@@ -143,6 +144,7 @@ These GitHub repositories provide supplementary resources for Rush Stack:
 | [/build-tests/eslint-7-7-test](./build-tests/eslint-7-7-test/) | This project contains a build test to validate ESLint 7.7.0 compatibility with the latest version of @rushstack/eslint-config (and by extension, the ESLint plugin) |
 | [/build-tests/eslint-7-test](./build-tests/eslint-7-test/) | This project contains a build test to validate ESLint 7 compatibility with the latest version of @rushstack/eslint-config (and by extension, the ESLint plugin) |
 | [/build-tests/eslint-8-test](./build-tests/eslint-8-test/) | This project contains a build test to validate ESLint 8 compatibility with the latest version of @rushstack/eslint-config (and by extension, the ESLint plugin) |
+| [/build-tests/eslint-bulk-suppressions-test](./build-tests/eslint-bulk-suppressions-test/) | Sample code to test eslint bulk suppressions |
 | [/build-tests/hashed-folder-copy-plugin-webpack5-test](./build-tests/hashed-folder-copy-plugin-webpack5-test/) | Building this project exercises @rushstack/hashed-folder-copy-plugin with Webpack 5. NOTE - THIS TEST IS CURRENTLY EXPECTED TO BE BROKEN |
 | [/build-tests/heft-copy-files-test](./build-tests/heft-copy-files-test/) | Building this project tests copying files with Heft |
 | [/build-tests/heft-example-plugin-01](./build-tests/heft-example-plugin-01/) | This is an example heft plugin that exposes hooks for other plugins |

build-tests/eslint-bulk-suppressions-test/client/.eslint-bulk-suppressions.json

@@ -0,0 +1,139 @@
+{
+  "suppressions": [
+    {
+      "file": "src/index.ts",
+      "scopeId": ".",
+      "rule": "prefer-const"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".ExampleClass",
+      "rule": "@typescript-eslint/ban-types"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".ExampleClass",
+      "rule": "@typescript-eslint/explicit-member-accessibility"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".ExampleClass.exampleMethod",
+      "rule": "@typescript-eslint/explicit-function-return-type"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".ExampleClass.exampleMethod",
+      "rule": "@typescript-eslint/explicit-member-accessibility"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".ExampleClass.exampleMethod",
+      "rule": "@typescript-eslint/typedef"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".ExampleClass.exampleMethod",
+      "rule": "no-var"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".exampleAnonymousClass",
+      "rule": "@typescript-eslint/explicit-member-accessibility"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".exampleAnonymousClass",
+      "rule": "@typescript-eslint/typedef"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".exampleAnonymousClass",
+      "rule": "no-useless-concat"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".exampleAnonymousClass.constructor",
+      "rule": "@typescript-eslint/explicit-member-accessibility"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".exampleAnonymousClass.exampleSetGet",
+      "rule": "@typescript-eslint/ban-types"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".exampleAnonymousClass.exampleSetGet",
+      "rule": "@typescript-eslint/explicit-function-return-type"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".exampleAnonymousClass.exampleSetGet",
+      "rule": "@typescript-eslint/explicit-member-accessibility"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".exampleArrowFunction",
+      "rule": "@typescript-eslint/explicit-function-return-type"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".exampleArrowFunction",
+      "rule": "@typescript-eslint/typedef"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".exampleArrowFunction",
+      "rule": "dot-notation"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".exampleArrowFunction",
+      "rule": "no-empty"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".exampleArrowFunction",
+      "rule": "no-unused-expressions"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".exampleFunction",
+      "rule": "@typescript-eslint/ban-types"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".exampleFunction",
+      "rule": "@typescript-eslint/explicit-function-return-type"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".exampleFunction",
+      "rule": "no-empty-pattern"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".exampleFunction",
+      "rule": "no-extra-boolean-cast"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".exampleObject",
+      "rule": "@typescript-eslint/typedef"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".x",
+      "rule": "@typescript-eslint/explicit-function-return-type"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".y",
+      "rule": "@typescript-eslint/explicit-function-return-type"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".z",
+      "rule": "@typescript-eslint/explicit-function-return-type"
+    }
+  ]
+}

build-tests/eslint-bulk-suppressions-test/client/.eslintrc.js

@@ -0,0 +1,32 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+// This is a workaround for https://github.com/eslint/eslint/issues/3458
+require('local-node-rig/profiles/default/includes/eslint/patch/modern-module-resolution');
+// This is a workaround for https://github.com/microsoft/rushstack/issues/3021
+require('local-node-rig/profiles/default/includes/eslint/patch/custom-config-package-names');
+require('local-node-rig/profiles/default/includes/eslint/patch/eslint-bulk-suppressions');
+
+module.exports = {
+  extends: [
+    'local-node-rig/profiles/default/includes/eslint/profile/node-trusted-tool',
+    'local-node-rig/profiles/default/includes/eslint/mixins/friendly-locals'
+  ],
+  ignorePatterns: ['.eslintrc.js'],
+
+  overrides: [
+    /**
+     * Override the parser from @rushstack/eslint-config. Since the config is coming
+     * from the workspace instead of the external NPM package, the versions of ESLint
+     * and TypeScript that the config consumes will be resolved from the devDependencies
+     * of the config instead of from the eslint-8-test package. Overriding the parser
+     * ensures that the these dependencies come from the eslint-8-test package. See:
+     * https://github.com/microsoft/rushstack/issues/3021
+     */
+    {
+      files: ['**/*.ts', '**/*.tsx'],
+      parser: '@typescript-eslint/parser',
+      parserOptions: { project: '../tsconfig.json', tsconfigRootDir: __dirname }
+    }
+  ]
+};

build-tests/eslint-bulk-suppressions-test/client/src/index.ts

@@ -0,0 +1,64 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+/* Top-level scope code samples */
+// scopeId: '.'
+let exampleString: string = 5 + '';
+
+const exampleObject = {
+  exampleString: exampleString
+};
+
+/* Function scope code samples */
+export function exampleFunction() {
+  const {}: Object = exampleObject;
+
+  // scopeId: '.exampleFunction'
+  !!!exampleString as Boolean;
+}
+
+// scope: '.ArrowFunctionExpression',
+export const x = () => {},
+  // scopeId: '.y'
+  y = () => {},
+  // scopeId: '.z'
+  z = () => {};
+
+/* Class scope code samples */
+export class ExampleClass {
+  // scopeId: '.ExampleClass'
+  exampleClassProperty: String = exampleString + '4';
+
+  exampleMethod() {
+    // scopeId: '.exampleClass.exampleMethod'
+    var exampleVar;
+    return exampleVar;
+  }
+}
+
+/* Variable and anonymous constructs code samples */
+export const exampleArrowFunction = () => {
+  const exampleBoolean = true;
+  if (exampleBoolean) {
+  }
+
+  exampleObject['exampleString'];
+};
+
+export const exampleAnonymousClass = class {
+  exampleClassProperty = 'x' + 'y';
+
+  // scopeId: '.exampleAnonymousClass.constructor'
+  constructor() {}
+
+  set exampleSetGet(val: string) {
+    // scopeId: '.exampleAnonymousClass.exampleSetGet'
+    let exampleVariable: Number = 1;
+    this.exampleClassProperty = val + exampleVariable;
+  }
+
+  get exampleSetGet() {
+    // scopeId: '.exampleAnonymousClass.exampleSetGet'
+    return this.exampleClassProperty as String as string;
+  }
+};

build-tests/eslint-bulk-suppressions-test/config/rig.json

@@ -0,0 +1,7 @@
+{
+  // The "rig.json" file directs tools to look for their config files in an external package.
+  // Documentation for this system: https://www.npmjs.com/package/@rushstack/rig-package
+  "$schema": "https://developer.microsoft.com/json-schemas/rig-package/rig.schema.json",
+
+  "rigPackageName": "local-node-rig"
+}

build-tests/eslint-bulk-suppressions-test/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "eslint-bulk-suppressions-test",
+  "description": "Sample code to test eslint bulk suppressions",
+  "version": "1.0.0",
+  "private": true,
+  "scripts": {
+    "lint": "eslint ."
+  },
+  "devDependencies": {
+    "@rushstack/heft": "workspace:*",
+    "local-node-rig": "workspace:*",
+    "@typescript-eslint/parser": "~5.59.2",
+    "eslint": "~8.7.0",
+    "typescript": "~5.0.4"
+  }
+}

build-tests/eslint-bulk-suppressions-test/server/.eslint-bulk-suppressions.json

@@ -0,0 +1,69 @@
+{
+  "suppressions": [
+    {
+      "file": "src/index.ts",
+      "scopeId": ".",
+      "rule": "@typescript-eslint/no-namespace"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".AbsurdClass.absurdClassMethod",
+      "rule": "@typescript-eslint/explicit-function-return-type"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".AbsurdClass.absurdClassMethod",
+      "rule": "@typescript-eslint/explicit-member-accessibility"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".AbsurdClass.absurdClassMethod.AbsurdClass2",
+      "rule": "@typescript-eslint/explicit-member-accessibility"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".AbsurdClass.absurdClassMethod.AbsurdClass2",
+      "rule": "@typescript-eslint/typedef"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".AbsurdClass.absurdClassMethod.AbsurdClass2.constructor",
+      "rule": "@typescript-eslint/explicit-member-accessibility"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".AbsurdClass.absurdClassMethod.AbsurdClass2.constructor.absurdObject",
+      "rule": "@typescript-eslint/typedef"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".ExampleEnum",
+      "rule": "dot-notation"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".ExampleInterface",
+      "rule": "@typescript-eslint/naming-convention"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".ExampleInterface2",
+      "rule": "@typescript-eslint/naming-convention"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".ExampleObjectType",
+      "rule": "@typescript-eslint/ban-types"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".ExampleObjectType",
+      "rule": "@typescript-eslint/consistent-type-definitions"
+    },
+    {
+      "file": "src/index.ts",
+      "scopeId": ".exampleObject2",
+      "rule": "@typescript-eslint/typedef"
+    }
+  ]
+}

build-tests/eslint-bulk-suppressions-test/server/.eslintrc.js

@@ -0,0 +1,32 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+// This is a workaround for https://github.com/eslint/eslint/issues/3458
+require('local-node-rig/profiles/default/includes/eslint/patch/modern-module-resolution');
+// This is a workaround for https://github.com/microsoft/rushstack/issues/3021
+require('local-node-rig/profiles/default/includes/eslint/patch/custom-config-package-names');
+require('local-node-rig/profiles/default/includes/eslint/patch/eslint-bulk-suppressions');
+
+module.exports = {
+  extends: [
+    'local-node-rig/profiles/default/includes/eslint/profile/node-trusted-tool',
+    'local-node-rig/profiles/default/includes/eslint/mixins/friendly-locals'
+  ],
+  ignorePatterns: ['.eslintrc.js'],
+
+  overrides: [
+    /**
+     * Override the parser from @rushstack/eslint-config. Since the config is coming
+     * from the workspace instead of the external NPM package, the versions of ESLint
+     * and TypeScript that the config consumes will be resolved from the devDependencies
+     * of the config instead of from the eslint-8-test package. Overriding the parser
+     * ensures that the these dependencies come from the eslint-8-test package. See:
+     * https://github.com/microsoft/rushstack/issues/3021
+     */
+    {
+      files: ['**/*.ts', '**/*.tsx'],
+      parser: '@typescript-eslint/parser',
+      parserOptions: { project: '../tsconfig.json', tsconfigRootDir: __dirname }
+    }
+  ]
+};