@git.zone/tstest 5.0.0 → 6.1.0

package/ts/tstest.classes.config.ts

@@ -0,0 +1,25 @@
+import * as plugins from './tstest.plugins.js';
+import type { ITstestConfig } from './tstest.interfaces.config.js';
+
+/**
+ * Read the `@git.zone/tstest` section of `.smartconfig.json`, following the
+ * same convention as tsbundle, tswatch, tsrust and tsdocker. A project
+ * without the section gets the defaults, so this is safe to call anywhere.
+ */
+export const loadTstestConfig = (cwd: string): ITstestConfig => {
+  try {
+    const smartconfigInstance = new plugins.smartconfig.Smartconfig(cwd);
+    return smartconfigInstance.dataFor<ITstestConfig>('@git.zone/tstest', {});
+  } catch (error) {
+    console.error(`tstest: could not read .smartconfig.json (${error}); using defaults`);
+    return {};
+  }
+};
+
+/** Cleanup runs on release unless the project opts out. */
+export const cleanupRunsOnRelease = (config: ITstestConfig): boolean =>
+  config.cleanup?.onRelease !== false;
+
+/** Cleanup after a local test run is opt-in. */
+export const cleanupRunsAfterTests = (config: ITstestConfig): boolean =>
+  config.cleanup?.afterRun === true;

package/ts/tstest.classes.tstest.ts

@@ -29,6 +29,8 @@ import {
 
 // Before-script support
 import { loadBeforeScripts, runBeforeScript, type IBeforeScripts } from './tstest.classes.beforescripts.js';
+import { cleanupRunsAfterTests, loadTstestConfig } from './tstest.classes.config.js';
+import { cleanArtifacts, formatBytes } from './tstest.classes.artifacts.js';
 
 export class TsTest {
   public testDir: TestDirectory;
@@ -164,6 +166,16 @@ export class TsTest {
    */
   public async cleanup() {
     this.smartshellInstance.smartexit.deregister();
+
+    // Opt-in: projects that do not want their test output kept can have it
+    // removed as soon as the run finishes.
+    const config = loadTstestConfig(this.testDir.cwd);
+    if (cleanupRunsAfterTests(config)) {
+      const result = cleanArtifacts(this.testDir.cwd, config);
+      if (result.totalBytes > 0) {
+        console.log(`tstest: cleaned test artifacts, reclaimed ${formatBytes(result.totalBytes)}`);
+      }
+    }
   }
 
   public async runWatch(ignorePatterns: string[] = []) {

package/ts/tstest.interfaces.config.ts

@@ -0,0 +1,55 @@
+/**
+ * Project configuration for tstest, read from the `@git.zone/tstest` section
+ * of `.smartconfig.json` - the same mechanism tsbundle, tswatch, tsrust and
+ * tsdocker already use.
+ */
+
+/**
+ * The artifact groups tstest writes to disk. Each maps to a fixed path under
+ * `.nogit/`; see `artifactPaths` in tstest.classes.artifacts.ts.
+ */
+export type TTstestArtifact = 'logs' | 'cache' | 'testfiles' | 'snapshots';
+
+export interface ITstestPrepareConfig {
+  /**
+   * Command run once, before the whole test run. Takes precedence over the
+   * `test:before` / `test:before:once` package.json scripts.
+   */
+  once?: string;
+  /**
+   * Command run before every individual test file. Takes precedence over the
+   * `test:before:testfile` package.json script.
+   */
+  perTestfile?: string;
+}
+
+export interface ITstestCleanupConfig {
+  /**
+   * Remove test artifacts as part of `gitzone release`. Defaults to true, so
+   * a release never ships with stale test output left on disk. Set false to
+   * opt a project out.
+   */
+  onRelease?: boolean;
+  /**
+   * Also remove artifacts after every local test run. Defaults to false,
+   * because the logs are usually the reason someone ran the tests.
+   */
+  afterRun?: boolean;
+  /**
+   * Artifact groups to remove. Defaults to logs, cache and testfiles.
+   * `snapshots` is deliberately not a default: snapshots are assertion
+   * baselines, and deleting them makes `matchSnapshot` silently re-record
+   * rather than compare.
+   */
+  artifacts?: TTstestArtifact[];
+  /**
+   * Additional project-specific paths to remove, relative to the project
+   * root. Absolute paths and paths escaping the project root are rejected.
+   */
+  additionalPaths?: string[];
+}
+
+export interface ITstestConfig {
+  prepare?: ITstestPrepareConfig;
+  cleanup?: ITstestCleanupConfig;
+}

package/ts/tstest.plugins.ts

@@ -8,6 +8,7 @@ export { fs, path, url };
 // @push.rocks scope
 import * as consolecolor from '@push.rocks/consolecolor';
 import * as smartbrowser from '@push.rocks/smartbrowser';
+import * as smartconfig from '@push.rocks/smartconfig';
 import * as smartserve from '@push.rocks/smartserve';
 import * as smartdelay from '@push.rocks/smartdelay';
 import * as smartfile from '@push.rocks/smartfile';
@@ -23,6 +24,7 @@ import * as tapbundle from '../dist_ts_tapbundle/index.js';
 export {
   consolecolor,
   smartbrowser,
+  smartconfig,
   smartserve,
   smartdelay,
   smartfile,