Delete suppressions file if all issues have been resolved.

microsoft · Mar 28, 2024 · 96d5dc4 · 96d5dc4
1 parent dc3ec45
commit 96d5dc4
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 10 deletions.
diff --git a/common/changes/@rushstack/eslint-patch/eslint-bulk-issues_2024-03-28-17-35.json b/common/changes/@rushstack/eslint-patch/eslint-bulk-issues_2024-03-28-17-35.json
@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@rushstack/eslint-patch",
+      "comment": "Delete the `.eslint-bulk-suppressions.json` file during pruning if all suppressions have been eliminated.",
+      "type": "minor"
+    }
+  ],
+  "packageName": "@rushstack/eslint-patch"
+}
diff --git a/eslint/eslint-patch/src/eslint-bulk-suppressions/bulk-suppressions-file.ts b/eslint/eslint-patch/src/eslint-bulk-suppressions/bulk-suppressions-file.ts
@@ -25,11 +25,18 @@ const IS_RUNNING_IN_VSCODE: boolean = process.env[VSCODE_PID_ENV_VAR_NAME] !== u
 const TEN_SECONDS_MS: number = 10 * 1000;
 const SUPPRESSIONS_JSON_FILENAME: string = '.eslint-bulk-suppressions.json';
 
+function throwIfAnythingOtherThanNotExistError(e: NodeJS.ErrnoException): void | never {
+  if (e?.code !== 'ENOENT') {
+    // Throw an error if any other error than file not found
+    throw e;
+  }
+}
+
 interface ICachedBulkSuppressionsConfig {
   readTime: number;
   suppressionsConfig: IBulkSuppressionsConfig;
 }
-export const suppressionsJsonByFolderPath: Map<string, ICachedBulkSuppressionsConfig> = new Map();
+const suppressionsJsonByFolderPath: Map<string, ICachedBulkSuppressionsConfig> = new Map();
 export function getSuppressionsConfigForEslintrcFolderPath(
   eslintrcFolderPath: string
 ): IBulkSuppressionsConfig {
@@ -51,10 +58,7 @@ export function getSuppressionsConfigForEslintrcFolderPath(
     try {
       rawJsonFile = fs.readFileSync(suppressionsPath).toString();
     } catch (e) {
-      // Throw an error if any other error than file not found
-      if (e.code !== 'ENOENT') {
-        throw e;
-      }
+      throwIfAnythingOtherThanNotExistError(e);
     }
 
     if (!rawJsonFile) {
@@ -87,14 +91,31 @@ export function getSuppressionsConfigForEslintrcFolderPath(
   return suppressionsConfig!;
 }
 
+export function getAllBulkSuppressionsConfigsByEslintrcFolderPath(): [string, IBulkSuppressionsConfig][] {
+  const result: [string, IBulkSuppressionsConfig][] = [];
+  for (const [eslintrcFolderPath, { suppressionsConfig }] of suppressionsJsonByFolderPath) {
+    result.push([eslintrcFolderPath, suppressionsConfig]);
+  }
+
+  return result;
+}
+
 export function writeSuppressionsJsonToFile(
   eslintrcDirectory: string,
   suppressionsConfig: IBulkSuppressionsConfig
 ): void {
   suppressionsJsonByFolderPath.set(eslintrcDirectory, { readTime: Date.now(), suppressionsConfig });
   const suppressionsPath: string = `${eslintrcDirectory}/${SUPPRESSIONS_JSON_FILENAME}`;
-  suppressionsConfig.jsonObject.suppressions.sort(compareSuppressions);
-  fs.writeFileSync(suppressionsPath, JSON.stringify(suppressionsConfig.jsonObject, undefined, 2));
+  if (suppressionsConfig.jsonObject.suppressions.length === 0) {
+    try {
+      fs.unlinkSync(suppressionsPath);
+    } catch (e) {
+      throwIfAnythingOtherThanNotExistError(e);
+    }
+  } else {
+    suppressionsConfig.jsonObject.suppressions.sort(compareSuppressions);
+    fs.writeFileSync(suppressionsPath, JSON.stringify(suppressionsConfig.jsonObject, undefined, 2));
+  }
 }
 
 export function serializeSuppression({ file, scopeId, rule }: ISuppression): string {

diff --git a/eslint/eslint-patch/src/eslint-bulk-suppressions/bulk-suppressions-patch.ts b/eslint/eslint-patch/src/eslint-bulk-suppressions/bulk-suppressions-patch.ts
@@ -18,7 +18,7 @@ import {
   type IBulkSuppressionsConfig,
   type ISuppression,
   writeSuppressionsJsonToFile,
-  suppressionsJsonByFolderPath
+  getAllBulkSuppressionsConfigsByEslintrcFolderPath
 } from './bulk-suppressions-file';
 
 const ESLINTRC_FILENAMES: string[] = [
@@ -169,7 +169,10 @@ export function shouldBulkSuppress(params: {
 }
 
 export function prune(): void {
-  for (const [eslintrcFolderPath, { suppressionsConfig }] of suppressionsJsonByFolderPath) {
+  for (const [
+    eslintrcFolderPath,
+    suppressionsConfig
+  ] of getAllBulkSuppressionsConfigsByEslintrcFolderPath()) {
     if (suppressionsConfig) {
       const { newSerializedSuppressions, newJsonObject } = suppressionsConfig;
       const newSuppressionsConfig: IBulkSuppressionsConfig = {
@@ -185,7 +188,10 @@ export function prune(): void {
 }
 
 export function write(): void {
-  for (const [eslintrcFolderPath, { suppressionsConfig }] of suppressionsJsonByFolderPath) {
+  for (const [
+    eslintrcFolderPath,
+    suppressionsConfig
+  ] of getAllBulkSuppressionsConfigsByEslintrcFolderPath()) {
     if (suppressionsConfig) {
       writeSuppressionsJsonToFile(eslintrcFolderPath, suppressionsConfig);
     }