feat(betterer ✨): allow configuration of default reporter

goldens/api/betterer.api.md

@@ -28,9 +28,10 @@ export namespace betterer {
 // Warning: (ae-incompatible-release-tags) The symbol "BettererConfig" is marked as @public, but its signature references "BettererConfigBase" which is marked as @internal
 // Warning: (ae-incompatible-release-tags) The symbol "BettererConfig" is marked as @public, but its signature references "BettererConfigStart" which is marked as @internal
 // Warning: (ae-incompatible-release-tags) The symbol "BettererConfig" is marked as @public, but its signature references "BettererConfigWatch" which is marked as @internal
+// Warning: (ae-incompatible-release-tags) The symbol "BettererConfig" is marked as @public, but its signature references "BettererConfigDefaultReporter" which is marked as @internal
 //
 // @public
-export interface BettererConfig extends BettererConfigBase, BettererConfigStart, BettererConfigWatch {
+export interface BettererConfig extends BettererConfigBase, BettererConfigStart, BettererConfigWatch, BettererConfigDefaultReporter {
 }
 
 // @internal
@@ -47,6 +48,12 @@ export interface BettererConfigBase {
     workers: number;
 }
 
+// @internal
+export interface BettererConfigDefaultReporter {
+    clearConsole: boolean;
+    showLogo: boolean;
+}
+
 // @public
 export type BettererConfigExcludes = ReadonlyArray<RegExp>;
 
@@ -225,7 +232,7 @@ export interface BettererFileTestResultSummary {
 export type BettererFileTestResultSummaryDetails = Record<string, BettererFileIssues>;
 
 // @internal
-export interface BettererOptionsBase {
+export interface BettererOptionsBase extends BettererOptionsDefaultReporter {
     cache?: boolean;
     cachePath?: string;
     configPaths?: BettererOptionsPaths;
@@ -238,6 +245,14 @@ export interface BettererOptionsBase {
     workers?: number | boolean;
 }
 
+// Warning: (tsdoc-escape-right-brace) The "}" character should be escaped using a backslash to avoid confusion with a TSDoc inline tag
+//
+// @public
+export interface BettererOptionsDefaultReporter {
+    clearConsole?: boolean;
+    showLogo?: boolean;
+}
+
 // @public
 export type BettererOptionsExcludes = Array<string | RegExp> | string | RegExp;
 

packages/betterer/src/config/config.ts

@@ -13,6 +13,7 @@ import {
   BettererConfigMerge,
   BettererConfigStart,
   BettererConfigWatch,
+  BettererOptionsDefaultReporter,
   BettererOptionsBase,
   BettererOptionsMerge,
   BettererOptionsOverride,
@@ -33,8 +34,9 @@ export async function createConfig(
   const baseConfig = await createBaseConfig(options as BettererOptionsBase, tsconfigPath, versionControl);
   const startConfig = createStartConfig(options as BettererOptionsStart);
   const watchConfig = createWatchConfig(options as BettererOptionsWatch);
+  const defaultReporterConfig = createDefaultReporterConfig(options as BettererOptionsDefaultReporter);
 
-  const config = { ...baseConfig, ...startConfig, ...watchConfig };
+  const config = { ...baseConfig, ...startConfig, ...watchConfig, ...defaultReporterConfig };
 
   modeConfig(config);
 
@@ -174,6 +176,19 @@ function createWatchConfig(options: BettererOptionsWatch): BettererConfigWatch {
   };
 }
 
+function createDefaultReporterConfig(options: BettererOptionsDefaultReporter) {
+  const clearConsole = options.clearConsole ?? true;
+  const showLogo = options.showLogo ?? true;
+
+  validateBool({ clearConsole });
+  validateBool({ showLogo });
+
+  return {
+    clearConsole,
+    showLogo
+  };
+}
+
 function modeConfig(config: BettererConfig) {
   // CI mode:
   if (config.ci) {

packages/betterer/src/config/public.ts

@@ -1,6 +1,7 @@
 export {
   BettererConfig,
   BettererConfigBase,
+  BettererConfigDefaultReporter,
   BettererConfigStart,
   BettererConfigWatch,
   BettererConfigExcludes,
@@ -20,6 +21,7 @@ export {
   BettererOptionsResults,
   BettererOptionsRunner,
   BettererOptionsStartBase,
+  BettererOptionsDefaultReporter,
   BettererOptionsStartCI,
   BettererOptionsStartDefault,
   BettererOptionsStartPrecommit,

packages/betterer/src/config/types.ts

@@ -33,7 +33,11 @@ export type BettererConfigPaths = ReadonlyArray<string>;
 /**
  * @public Full validated config object for **Betterer**.
  */
-export interface BettererConfig extends BettererConfigBase, BettererConfigStart, BettererConfigWatch {}
+export interface BettererConfig
+  extends BettererConfigBase,
+    BettererConfigStart,
+    BettererConfigWatch,
+    BettererConfigDefaultReporter {}
 
 export type BettererWorkerRunConfig = Omit<BettererConfig, 'reporter'>;
 
@@ -174,6 +178,25 @@ export interface BettererConfigMerge {
   resultsPath: string;
 }
 
+/**
+ * @internal This could change at any point! Please don't use!
+ *
+ * Configuration for the **Betterer** default reporter.
+ */
+export interface BettererConfigDefaultReporter {
+  /**
+   * When `true`, the betterer logo will be shown.
+   * @defaultValue `true`
+   */
+  showLogo: boolean;
+
+  /**
+   * When `true`, the console is cleared before each suite.
+   * @defaultValue `true`
+   */
+  clearConsole: boolean;
+}
+
 /**
  * @public A path to a {@link https://phenomnomnominal.github.io/betterer/docs/test-definition-file | test definition file }
  * containing **Betterer** tests, or an array of them.
@@ -286,7 +309,7 @@ export interface BettererOptionsMerge {
  *
  * Base options for **Betterer** all running modes.
  */
-export interface BettererOptionsBase {
+export interface BettererOptionsBase extends BettererOptionsDefaultReporter {
   /**
    * When `true`, caching will be enabled for {@link @betterer/betterer#BettererFileTest | `BettererFileTest`s}.
    * Betterer will only check files that have changes since the last test run. **Betterer** will
@@ -341,6 +364,7 @@ export interface BettererOptionsBase {
    * The `tsconfigPath` should be relative to the `cwd`.
    * @defaultValue `null`
    */
+
   tsconfigPath?: string;
   /**
    * The number of {@link https://nodejs.org/api/worker_threads.html | worker threads } to use when
@@ -514,3 +538,19 @@ export interface BettererOptionsOverride {
    */
   reporters?: BettererOptionsReporters;
 }
+/**
+ * @public Options for the **Betterer** default reporter }
+ */
+export interface BettererOptionsDefaultReporter {
+  /**
+   * When `true`, the betterer logo will be shown in the default reporter.
+   * @defaultValue `true`
+   */
+  showLogo?: boolean;
+
+  /**
+   * When `true`, the console is cleared before each suite.
+   * @defaultValue `true`
+   */
+  clearConsole?: boolean;
+}

packages/betterer/src/index.ts

@@ -8,6 +8,7 @@ export { betterer, merge, results, runner, watch } from './betterer';
 export {
   BettererConfig,
   BettererConfigBase,
+  BettererConfigDefaultReporter,
   BettererConfigStart,
   BettererConfigWatch,
   BettererConfigExcludes,
@@ -27,6 +28,7 @@ export {
   BettererOptionsResults,
   BettererOptionsRunner,
   BettererOptionsStartBase,
+  BettererOptionsDefaultReporter,
   BettererOptionsStartCI,
   BettererOptionsStartDefault,
   BettererOptionsStartPrecommit,

packages/betterer/src/run/worker-run-config.ts

@@ -18,6 +18,8 @@ export function createWorkerRunConfig(config: BettererConfig): BettererWorkerRun
     update: config.update,
     versionControlPath: config.versionControlPath,
     watch: config.watch,
-    workers: config.workers
+    workers: config.workers,
+    showLogo: config.showLogo,
+    clearConsole: config.clearConsole
   };
 }

packages/reporter/src/components/Reporter.tsx

@@ -22,7 +22,7 @@ export const Reporter: FC<BettererReporterState> = function Reporter(props: Bett
 
   return (
     <Box flexDirection="column">
-      <BettererLogo />
+      {context.config.showLogo ? <BettererLogo /> : null}
       <ReporterComponent {...props} />
     </Box>
   );

packages/reporter/src/reporter.tsx

@@ -63,8 +63,11 @@ function createReporter(): BettererReporter {
       render(action?: BettererReporterAction, done?: () => void): void {
         const state = dispatch(action);
         // eslint-disable-next-line no-console
-        console.clear();
         const component = <Reporter {...state} done={done} />;
+        if (context.config.clearConsole) {
+          // eslint-disable-next-line no-console
+          console.clear();
+        }
         if (!app) {
           app = render(component, RENDER_OPTIONS);
         } else {