@rushstack/eslint-bulk 0.1.0

package/LICENSE

@@ -0,0 +1,24 @@
+@rushstack/eslint-bulk
+
+Copyright (c) Microsoft Corporation. All rights reserved.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,37 @@
+# @rushstack/eslint-bulk
+
+This is a companion package for @rushstack/eslint-patch that should be installed globally as follows:
+```bash
+npm i -g @rushstack/eslint-bulk
+```
+
+The **eslint-bulk** package is a set of command line tools to use with the ESLint bulk suppressions patch.
+eslint-bulk commands must be run in the same current working directory containing your package's pertaining
+.eslintrc.js or .eslintrc.cjs file.
+
+## eslint-bulk suppress
+
+Use this command to automatically generate bulk suppressions for the given files and given rules.
+Supply the paths as the main argument. The paths argument is a glob pattern that follows the same
+rules as the "files" argument in the "eslint" command.
+
+```bash
+eslint-bulk suppress --rule NAME1 [--rule NAME2...] PATH1 [PATH2...]
+eslint-bulk suppress --all PATH1 [PATH2...]
+```
+
+## eslint-bulk prune
+
+Use this command to automatically delete all unused suppression entries in all .eslint-bulk-suppressions.json
+files under the current working directory.
+
+```bash
+eslint-bulk prune
+```
+
+# Links
+
+- [CHANGELOG.md](https://github.com/microsoft/rushstack/blob/main/eslint/eslint-bulk/CHANGELOG.md) - Find
+  out what's new in the latest version
+
+`@rushstack/eslint-bulk` is part of the [Rush Stack](https://rushstack.io/) family of projects.

package/bin/eslint-bulk

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require('../lib/start.js');

package/lib/start.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=start.d.ts.map

package/lib/start.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"start.d.ts","sourceRoot":"","sources":["../src/start.ts"],"names":[],"mappings":""}

package/lib/start.js

@@ -0,0 +1,109 @@
+"use strict";
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const child_process_1 = require("child_process");
+const process = __importStar(require("process"));
+const fs = __importStar(require("fs"));
+const path = __importStar(require("path"));
+function findPatchPath() {
+    let eslintrcPath;
+    if (fs.existsSync(path.join(process.cwd(), '.eslintrc.js'))) {
+        eslintrcPath = '.eslintrc.js';
+    }
+    else if (fs.existsSync(path.join(process.cwd(), '.eslintrc.cjs'))) {
+        eslintrcPath = '.eslintrc.cjs';
+    }
+    else {
+        console.error('@rushstack/eslint-bulk: Please run this command from the directory that contains .eslintrc.js or .eslintrc.cjs');
+        process.exit(1);
+    }
+    const env = Object.assign(Object.assign({}, process.env), { _RUSHSTACK_ESLINT_BULK_DETECT: 'true' });
+    let stdout;
+    try {
+        stdout = (0, child_process_1.execSync)(`eslint --stdin --config ${eslintrcPath}`, { env, input: '', stdio: 'pipe' });
+    }
+    catch (e) {
+        console.error('@rushstack/eslint-bulk: Error finding patch path: ' + e.message);
+        process.exit(1);
+    }
+    const startDelimiter = 'RUSHSTACK_ESLINT_BULK_START';
+    const endDelimiter = 'RUSHSTACK_ESLINT_BULK_END';
+    const regex = new RegExp(`${startDelimiter}(.*?)${endDelimiter}`);
+    const match = stdout.toString().match(regex);
+    if (match) {
+        // The configuration data will look something like this:
+        //
+        // RUSHSTACK_ESLINT_BULK_START{"minCliVersion":"0.0.0","cliEntryPoint":"path/to/eslint-bulk.js"}RUSHSTACK_ESLINT_BULK_END
+        const configurationJson = match[1].trim();
+        let configuration;
+        try {
+            configuration = JSON.parse(configurationJson);
+            if (!configuration.minCliVersion || !configuration.cliEntryPoint) {
+                throw new Error('Required field is missing');
+            }
+        }
+        catch (e) {
+            console.error('@rushstack/eslint-bulk: Error parsing patch configuration object:' + e.message);
+            process.exit(1);
+        }
+        const myVersion = require('../package.json').version;
+        const myVersionParts = myVersion.split('.').map((x) => parseInt(x, 10));
+        const minVersion = configuration.minCliVersion;
+        const minVersionParts = minVersion.split('.').map((x) => parseInt(x, 10));
+        if (myVersionParts.length !== 3 ||
+            minVersionParts.length !== 3 ||
+            myVersionParts.some((x) => isNaN(x)) ||
+            minVersionParts.some((x) => isNaN(x))) {
+            console.error(`@rushstack/eslint-bulk: Unable to compare versions "${myVersion}" and "${minVersion}"`);
+            process.exit(1);
+        }
+        for (let i = 0; i < 3; ++i) {
+            if (myVersionParts[i] > minVersionParts[i]) {
+                break;
+            }
+            if (myVersionParts[i] < minVersionParts[i]) {
+                console.error(`@rushstack/eslint-bulk: The @rushstack/eslint-bulk version ${myVersion} is too old;` +
+                    ` please upgrade to ${minVersion} or newer.`);
+                process.exit(1);
+            }
+        }
+        return configuration.cliEntryPoint;
+    }
+    console.error('@rushstack/eslint-bulk: Error finding patch path. Are you sure the package you are in has @rushstack/eslint-patch as a direct or indirect dependency?');
+    process.exit(1);
+}
+const patchPath = findPatchPath();
+try {
+    const args = process.argv.slice(2).join(' ');
+    const command = `node ${patchPath} ${args}`;
+    (0, child_process_1.execSync)(command, { stdio: 'inherit' });
+}
+catch (e) {
+    console.error(`@rushstack/eslint-bulk: Error running patch at ${patchPath}:\n` + e.message);
+    process.exit(1);
+}
+//# sourceMappingURL=start.js.map

package/lib/start.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"start.js","sourceRoot":"","sources":["../src/start.ts"],"names":[],"mappings":";AAAA,4FAA4F;AAC5F,2DAA2D;;;;;;;;;;;;;;;;;;;;;;;;;AAE3D,iDAAyC;AACzC,iDAAmC;AACnC,uCAAyB;AACzB,2CAA6B;AAa7B,SAAS,aAAa;IACpB,IAAI,YAAoB,CAAC;IACzB,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,cAAc,CAAC,CAAC,EAAE;QAC3D,YAAY,GAAG,cAAc,CAAC;KAC/B;SAAM,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,eAAe,CAAC,CAAC,EAAE;QACnE,YAAY,GAAG,eAAe,CAAC;KAChC;SAAM;QACL,OAAO,CAAC,KAAK,CACX,gHAAgH,CACjH,CAAC;QACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IAED,MAAM,GAAG,mCAA2B,OAAO,CAAC,GAAG,KAAE,6BAA6B,EAAE,MAAM,GAAE,CAAC;IAEzF,IAAI,MAAc,CAAC;IACnB,IAAI;QACF,MAAM,GAAG,IAAA,wBAAQ,EAAC,2BAA2B,YAAY,EAAE,EAAE,EAAE,GAAG,EAAE,KAAK,EAAE,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;KACjG;IAAC,OAAO,CAAC,EAAE;QACV,OAAO,CAAC,KAAK,CAAC,oDAAoD,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC;QAChF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;KACjB;IAED,MAAM,cAAc,GAAW,6BAA6B,CAAC;IAC7D,MAAM,YAAY,GAAW,2BAA2B,CAAC;IAEzD,MAAM,KAAK,GAAW,IAAI,MAAM,CAAC,GAAG,cAAc,QAAQ,YAAY,EAAE,CAAC,CAAC;IAC1E,MAAM,KAAK,GAA4B,MAAM,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAEtE,IAAI,KAAK,EAAE;QACT,wDAAwD;QACxD,EAAE;QACF,yHAAyH;QACzH,MAAM,iBAAiB,GAAW,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAClD,IAAI,aAA2C,CAAC;QAChD,IAAI;YACF,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;YAC9C,IAAI,CAAC,aAAa,CAAC,aAAa,IAAI,CAAC,aAAa,CAAC,aAAa,EAAE;gBAChE,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;aAC9C;SACF;QAAC,OAAO,CAAC,EAAE;YACV,OAAO,CAAC,KAAK,CAAC,mEAAmE,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC;YAC/F,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACjB;QAED,MAAM,SAAS,GAAW,OAAO,CAAC,iBAAiB,CAAC,CAAC,OAAO,CAAC;QAC7D,MAAM,cAAc,GAAa,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;QAClF,MAAM,UAAU,GAAW,aAAa,CAAC,aAAa,CAAC;QACvD,MAAM,eAAe,GAAa,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;QACpF,IACE,cAAc,CAAC,MAAM,KAAK,CAAC;YAC3B,eAAe,CAAC,MAAM,KAAK,CAAC;YAC5B,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YACpC,eAAe,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,EACrC;YACA,OAAO,CAAC,KAAK,CAAC,uDAAuD,SAAS,UAAU,UAAU,GAAG,CAAC,CAAC;YACvG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;SACjB;QAED,KAAK,IAAI,CAAC,GAAW,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,EAAE;YAClC,IAAI,cAAc,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,EAAE;gBAC1C,MAAM;aACP;YACD,IAAI,cAAc,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,CAAC,CAAC,EAAE;gBAC1C,OAAO,CAAC,KAAK,CACX,8DAA8D,SAAS,cAAc;oBACnF,sBAAsB,UAAU,YAAY,CAC/C,CAAC;gBACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;aACjB;SACF;QAED,OAAO,aAAa,CAAC,aAAa,CAAC;KACpC;IAED,OAAO,CAAC,KAAK,CACX,uJAAuJ,CACxJ,CAAC;IACF,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAClB,CAAC;AAED,MAAM,SAAS,GAAW,aAAa,EAAE,CAAC;AAC1C,IAAI;IACF,MAAM,IAAI,GAAW,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACrD,MAAM,OAAO,GAAW,QAAQ,SAAS,IAAI,IAAI,EAAE,CAAC;IACpD,IAAA,wBAAQ,EAAC,OAAO,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC,CAAC;CACzC;AAAC,OAAO,CAAC,EAAE;IACV,OAAO,CAAC,KAAK,CAAC,kDAAkD,SAAS,KAAK,GAAG,CAAC,CAAC,OAAO,CAAC,CAAC;IAC5F,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;CACjB","sourcesContent":["// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.\n// See LICENSE in the project root for license information.\n\nimport { execSync } from 'child_process';\nimport * as process from 'process';\nimport * as fs from 'fs';\nimport * as path from 'path';\n\ninterface IEslintBulkConfigurationJson {\n  /**\n   * `@rushtack/eslint`-bulk should report an error if its package.json is older than this number\n   */\n  minCliVersion: string;\n  /**\n   * `@rushtack/eslint-bulk` will invoke this entry point\n   */\n  cliEntryPoint: string;\n}\n\nfunction findPatchPath(): string {\n  let eslintrcPath: string;\n  if (fs.existsSync(path.join(process.cwd(), '.eslintrc.js'))) {\n    eslintrcPath = '.eslintrc.js';\n  } else if (fs.existsSync(path.join(process.cwd(), '.eslintrc.cjs'))) {\n    eslintrcPath = '.eslintrc.cjs';\n  } else {\n    console.error(\n      '@rushstack/eslint-bulk: Please run this command from the directory that contains .eslintrc.js or .eslintrc.cjs'\n    );\n    process.exit(1);\n  }\n\n  const env: NodeJS.ProcessEnv = { ...process.env, _RUSHSTACK_ESLINT_BULK_DETECT: 'true' };\n\n  let stdout: Buffer;\n  try {\n    stdout = execSync(`eslint --stdin --config ${eslintrcPath}`, { env, input: '', stdio: 'pipe' });\n  } catch (e) {\n    console.error('@rushstack/eslint-bulk: Error finding patch path: ' + e.message);\n    process.exit(1);\n  }\n\n  const startDelimiter: string = 'RUSHSTACK_ESLINT_BULK_START';\n  const endDelimiter: string = 'RUSHSTACK_ESLINT_BULK_END';\n\n  const regex: RegExp = new RegExp(`${startDelimiter}(.*?)${endDelimiter}`);\n  const match: RegExpMatchArray | null = stdout.toString().match(regex);\n\n  if (match) {\n    // The configuration data will look something like this:\n    //\n    // RUSHSTACK_ESLINT_BULK_START{\"minCliVersion\":\"0.0.0\",\"cliEntryPoint\":\"path/to/eslint-bulk.js\"}RUSHSTACK_ESLINT_BULK_END\n    const configurationJson: string = match[1].trim();\n    let configuration: IEslintBulkConfigurationJson;\n    try {\n      configuration = JSON.parse(configurationJson);\n      if (!configuration.minCliVersion || !configuration.cliEntryPoint) {\n        throw new Error('Required field is missing');\n      }\n    } catch (e) {\n      console.error('@rushstack/eslint-bulk: Error parsing patch configuration object:' + e.message);\n      process.exit(1);\n    }\n\n    const myVersion: string = require('../package.json').version;\n    const myVersionParts: number[] = myVersion.split('.').map((x) => parseInt(x, 10));\n    const minVersion: string = configuration.minCliVersion;\n    const minVersionParts: number[] = minVersion.split('.').map((x) => parseInt(x, 10));\n    if (\n      myVersionParts.length !== 3 ||\n      minVersionParts.length !== 3 ||\n      myVersionParts.some((x) => isNaN(x)) ||\n      minVersionParts.some((x) => isNaN(x))\n    ) {\n      console.error(`@rushstack/eslint-bulk: Unable to compare versions \"${myVersion}\" and \"${minVersion}\"`);\n      process.exit(1);\n    }\n\n    for (let i: number = 0; i < 3; ++i) {\n      if (myVersionParts[i] > minVersionParts[i]) {\n        break;\n      }\n      if (myVersionParts[i] < minVersionParts[i]) {\n        console.error(\n          `@rushstack/eslint-bulk: The @rushstack/eslint-bulk version ${myVersion} is too old;` +\n            ` please upgrade to ${minVersion} or newer.`\n        );\n        process.exit(1);\n      }\n    }\n\n    return configuration.cliEntryPoint;\n  }\n\n  console.error(\n    '@rushstack/eslint-bulk: Error finding patch path. Are you sure the package you are in has @rushstack/eslint-patch as a direct or indirect dependency?'\n  );\n  process.exit(1);\n}\n\nconst patchPath: string = findPatchPath();\ntry {\n  const args: string = process.argv.slice(2).join(' ');\n  const command: string = `node ${patchPath} ${args}`;\n  execSync(command, { stdio: 'inherit' });\n} catch (e) {\n  console.error(`@rushstack/eslint-bulk: Error running patch at ${patchPath}:\\n` + e.message);\n  process.exit(1);\n}\n"]}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@rushstack/eslint-bulk",
+  "version": "0.1.0",
+  "description": "A set of helper CLIs to use with the rushstack ESLint toolchain",
+  "main": "index.js",
+  "license": "MIT",
+  "repository": {
+    "url": "https://github.com/microsoft/rushstack.git",
+    "type": "git",
+    "directory": "eslint/eslint-bulk"
+  },
+  "homepage": "https://rushstack.io",
+  "bin": {
+    "eslint-bulk": "./bin/eslint-bulk"
+  },
+  "keywords": [
+    "eslintrc",
+    "eslint",
+    "bulk",
+    "legacy",
+    "retroactive",
+    "disable",
+    "ignore",
+    "suppression"
+  ],
+  "devDependencies": {
+    "@types/node": "18.17.15",
+    "local-node-rig": "1.0.0",
+    "@rushstack/heft": "0.63.2"
+  },
+  "scripts": {
+    "build": "heft build --clean",
+    "_phase:build": "heft run --only build -- --clean",
+    "start": "node ./lib/start.js"
+  }
+}