refactor: safer test folder teardown and clean test folder init

Author: vmasek

e2e/cli-e2e/tests/__snapshots__/help.e2e.test.ts.snap

@@ -21,7 +21,8 @@ Global Options:
       --progress        Show progress bar in stdout.
                                              [boolean] [default: true]
       --verbose         When true creates more verbose output. This is helpful w
-                        hen debugging. [boolean] [default: false]
+                        hen debugging. You may also set CP_VERBOSE env variable
+                        instead.       [boolean] [default: false]
       --config          Path to config file. By default it loads code-pushup.con
                         fig.(ts|mjs|js).                 [string]
       --tsconfig        Path to a TypeScript config, to be used when loading con
@@ -65,9 +66,9 @@ Examples:
   code-pushup collect --onlyPlugins=covera  Run collect with only coverage plugi
   ge                                        n, other plugins from config file wi
                                             ll be skipped.
-  code-pushup collect --skipPlugins=covera  Run collect skiping the coverage plu
-  ge                                        gin, other plugins from config file
-                                            will be included.
+  code-pushup collect --skipPlugins=covera  Run collect skipping the coverage pl
+  ge                                        ugin, other plugins from config file
+                                             will be included.
   code-pushup upload --persist.outputDir=d  Upload dist/report.json to portal us
   ist --upload.apiKey=$CP_API_KEY           ing API key from environment variabl
                                             e

packages/cli/README.md

@@ -195,12 +195,12 @@ Each example is fully tested to demonstrate best practices for plugin testing as
 
 ### Global Options
 
-| Option           | Type      | Default                                      | Description                                                            |
-| ---------------- | --------- | -------------------------------------------- | ---------------------------------------------------------------------- |
-| **`--progress`** | `boolean` | `true`                                       | Show progress bar in stdout.                                           |
-| **`--verbose`**  | `boolean` | `false`                                      | When true creates more verbose output. This is helpful when debugging. |
-| **`--config`**   | `string`  | looks for `code-pushup.config.{ts\|mjs\|js}` | Path to config file.                                                   |
-| **`--tsconfig`** | `string`  | n/a                                          | Path to a TypeScript config, used to load config file.                 |
+| Option           | Type      | Default                                      | Description                                                                                                                |
+| ---------------- | --------- | -------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
+| **`--progress`** | `boolean` | `true`                                       | Show progress bar in stdout.                                                                                               |
+| **`--verbose`**  | `boolean` | `false`                                      | When true creates more verbose output. This is helpful when debugging. You may also set `CP_VERBOSE` env variable instead. |
+| **`--config`**   | `string`  | looks for `code-pushup.config.{ts\|mjs\|js}` | Path to config file.                                                                                                       |
+| **`--tsconfig`** | `string`  | n/a                                          | Path to a TypeScript config, used to load config file.                                                                     |
 
 > [!NOTE]  
 > By default, the CLI loads `code-pushup.config.(ts|mjs|js)` if no config path is provided with `--config`.

packages/cli/src/lib/cli.ts

@@ -25,7 +25,7 @@ export const cli = (args: string[]) =>
       ],
       [
         'code-pushup collect --skipPlugins=coverage',
-        'Run collect skiping the coverage plugin, other plugins from config file will be included.',
+        'Run collect skipping the coverage plugin, other plugins from config file will be included.',
       ],
       [
         'code-pushup upload --persist.outputDir=dist --upload.apiKey=$CP_API_KEY',

testing/test-setup/src/lib/test-folder.setup.ts

@@ -1,17 +1,27 @@
 import { logger } from '@nx/devkit';
 import { bold } from 'ansis';
-import { mkdir, rm } from 'node:fs/promises';
-
-export async function setupTestFolder(dirName: string) {
-  await mkdir(dirName, { recursive: true });
-}
+import { mkdir, rm, stat } from 'node:fs/promises';
 
 export async function cleanTestFolder(dirName: string) {
-  await rm(dirName, { recursive: true, force: true });
+  await teardownTestFolder(dirName);
   await mkdir(dirName, { recursive: true });
 }
 
 export async function teardownTestFolder(dirName: string) {
+  try {
+    const stats = await stat(dirName);
+    if (!stats.isDirectory()) {
+      logger.warn(
+        `⚠️ You are trying to delete single file instead of directory ${bold(
+          dirName,
+        )}.`,
+      );
+    }
+  } catch {
+    // continue safely without deleting as folder does not exist in the filesystem
+    return;
+  }
+
   try {
     await rm(dirName, {
       recursive: true,