chore: more tests, cleanup

.eslintrc.js

@@ -135,6 +135,14 @@ module.exports = {
 
         '@typescript-eslint/switch-exhaustiveness-check': 'error',
 
+        '@typescript-eslint/no-unused-vars': [
+          'error',
+          {
+            argsIgnorePattern: '^_',
+            varsIgnorePattern: '^_',
+          },
+        ],
+
         '@stylistic/ts/lines-around-comment': [
           'warn',
           {

packages/midnight-smoker/src/error/aggregate-pkg-manager-error.ts

@@ -1,5 +1,5 @@
 import pluralize from 'pluralize';
-import {AggregateSmokerError} from './base-error';
+import {AggregateSmokerError} from './aggregate-smoker-error';
 import {type UnsupportedPackageManagerError} from './unsupported-pkg-manager-error';
 
 /**

packages/midnight-smoker/src/error/aggregate-smoker-error.ts

@@ -0,0 +1,61 @@
+import {isZodError} from '#util/error-util';
+import {castArray} from '#util/util';
+import {fromZodError} from 'zod-validation-error';
+import {BaseSmokerError, getErrorCode, type SmokerError} from './base-error';
+import type {SmokerErrorCode, SmokerErrorId} from './codes';
+
+/**
+ * Base class for all aggregate exceptions thrown by `midnight-smoker`.
+ *
+ * This should only be used if _multiple_ errors are being collected--not just
+ * catching some `Error` then throwing our own; use {@link BaseSmokerError} for
+ * that.
+ *
+ * @template Context - Arbitrary per-exception-class data to attach to the
+ *   error.
+ * @group Errors
+ */
+
+export abstract class AggregateSmokerError<Context extends object | void = void>
+  extends AggregateError
+  implements SmokerError<Context>
+{
+  public override readonly cause?: void;
+
+  public readonly context?: Context;
+
+  public readonly code: SmokerErrorCode;
+
+  public abstract readonly id: SmokerErrorId;
+
+  /**
+   * @privateRemarks
+   * Why doesn't the {@link AggregateError} constructor set this value?
+   */
+  public override errors: Error[];
+
+  constructor(message: string, errors?: Error[] | Error, context?: Context) {
+    const errs = castArray(errors).map((err) =>
+      isZodError(err) ? fromZodError(err) : err,
+    );
+    super(errs, message);
+    this.context = context ?? undefined;
+    this.errors = errs;
+    this.code = getErrorCode(this);
+  }
+
+  public format(verbose = false) {
+    return BaseSmokerError.prototype.format.call(this, verbose);
+  }
+
+  public toJSON() {
+    return {
+      message: this.message,
+      id: this.id,
+      stack: this.stack,
+      context: this.context,
+      code: this.code,
+      errors: this.errors,
+    };
+  }
+}

packages/midnight-smoker/src/error/base-error.ts

@@ -1,10 +1,7 @@
-import {isZodError} from '#util/error-util';
-import {castArray} from '#util/util';
 import {italic, white, whiteBright, yellow} from 'chalk';
 import Debug from 'debug';
 import {format, formatWithOptions} from 'node:util';
 import stringify from 'stringify-object';
-import {fromZodError} from 'zod-validation-error';
 import type {SmokerErrorCode, SmokerErrorId} from './codes';
 import {ErrorCodes} from './codes';
 
@@ -23,7 +20,7 @@ export const debug = Debug('midnight-smoker:error');
  *   Note that this will throw _during_ the instantiation of an `Error` about to
  *   be thrown.
  */
-function getErrorCode(err: SmokerError<any, any>): SmokerErrorCode {
+export function getErrorCode(err: SmokerError<any, any>): SmokerErrorCode {
   const {name} = err.constructor;
   if (!(name in ErrorCodes)) {
     throw new ReferenceError(`${name} missing an error code`);
@@ -93,62 +90,6 @@ export abstract class BaseSmokerError<
   }
 }
 
-/**
- * Base class for all aggregate exceptions thrown by `midnight-smoker`.
- *
- * This should only be used if _multiple_ errors are being collected--not just
- * catching some `Error` then throwing our own; use {@link BaseSmokerError} for
- * that.
- *
- * @template Context - Arbitrary per-exception-class data to attach to the
- *   error.
- * @group Errors
- */
-
-export abstract class AggregateSmokerError<Context extends object | void = void>
-  extends AggregateError
-  implements SmokerError<Context>
-{
-  public override readonly cause?: void;
-
-  public readonly context?: Context;
-
-  public readonly code: SmokerErrorCode;
-
-  public abstract readonly id: SmokerErrorId;
-
-  /**
-   * @privateRemarks
-   * Why doesn't the {@link AggregateError} constructor set this value?
-   */
-  public override errors: Error[];
-
-  constructor(message: string, errors?: Error[] | Error, context?: Context) {
-    const errs = castArray(errors).map((err) =>
-      isZodError(err) ? fromZodError(err) : err,
-    );
-    super(errs, message);
-    this.context = context ?? undefined;
-    this.errors = errs;
-    this.code = getErrorCode(this);
-  }
-
-  public format(verbose = false) {
-    return BaseSmokerError.prototype.format.call(this, verbose);
-  }
-
-  public toJSON() {
-    return {
-      message: this.message,
-      id: this.id,
-      stack: this.stack,
-      context: this.context,
-      code: this.code,
-      errors: this.errors,
-    };
-  }
-}
-
 /**
  * Options for {@link SmokerError} with a generic `Cause` type for `cause` prop.
  */

packages/midnight-smoker/src/error/cleanup-error.ts

@@ -10,11 +10,11 @@ export class CleanupError extends BaseSmokerError<
   {
     dir: string;
   },
-  NodeJS.ErrnoException
+  Error
 > {
   public readonly id = 'CleanupError';
 
-  constructor(message: string, dir: string, error: NodeJS.ErrnoException) {
+  constructor(message: string, dir: string, error: Error) {
     super(message, {dir}, error);
   }
 }

packages/midnight-smoker/src/error/codes.ts

@@ -10,6 +10,7 @@
  */
 export const ErrorCodes = {
   AbortError: 'ESMOKER_ABORT',
+  AggregatePackError: 'ESMOKER_AGGREGATEPACKERROR',
   AggregateUnsupportedPkgManagerError: 'ESMOKER_UNSUPPORTEDPACKAGEMANAGERS',
   CleanupError: 'ESMOKER_CLEANUP',
   ComponentCollisionError: 'ESMOKER_COMPONENTIDCOLLISION',

packages/midnight-smoker/src/error/index.ts

@@ -2,6 +2,8 @@ export * from './abort-error';
 
 export * from './aggregate-pkg-manager-error';
 
+export * from './aggregate-smoker-error';
+
 export * from './base-error';
 
 export * from './cleanup-error';
@@ -34,6 +36,8 @@ export * from './not-implemented-error';
 
 export * from './pack-error';
 
+export * from './pack-parse-error';
+
 export * from './pkg-manager-error';
 
 export * from './pkg-manager';
@@ -62,6 +66,8 @@ export * from './smoke-error';
 
 export * from './smoker-reference-error';
 
+export * from './some-pack-error';
+
 export * from './temp-dir-error';
 
 export * from './unknown-dist-tag-error';

packages/midnight-smoker/src/error/machine-error.ts

@@ -1,5 +1,5 @@
 import {castArray} from 'lodash';
-import {AggregateSmokerError} from './base-error';
+import {AggregateSmokerError} from './aggregate-smoker-error';
 
 /**
  * Generic aggregate error for machines

packages/midnight-smoker/src/error/pack-error.ts

@@ -37,28 +37,3 @@ export class PackError extends BaseSmokerError<
     );
   }
 }
-
-/**
- * @group Errors
- */
-export class PackParseError extends BaseSmokerError<
-  {
-    pkgManager: string;
-    output: string;
-    workspace: WorkspaceInfo;
-  },
-  SyntaxError
-> {
-  public readonly id = 'PackParseError';
-
-  constructor(
-    message: string,
-    pkgManager: string | StaticPkgManagerSpec,
-    workspace: WorkspaceInfo,
-    error: SyntaxError,
-    output: string,
-  ) {
-    const pmSpec = isString(pkgManager) ? pkgManager : pkgManager.spec;
-    super(message, {pkgManager: pmSpec, output, workspace}, error);
-  }
-}

packages/midnight-smoker/src/error/pack-parse-error.ts

@@ -0,0 +1,30 @@
+import {type StaticPkgManagerSpec} from '#schema/static-pkg-manager-spec';
+import {type WorkspaceInfo} from '#schema/workspaces';
+import {isString} from 'lodash';
+import {BaseSmokerError} from './base-error';
+
+/**
+ * @group Errors
+ */
+
+export class PackParseError extends BaseSmokerError<
+  {
+    pkgManager: string;
+    output: string;
+    workspace: WorkspaceInfo;
+  },
+  SyntaxError
+> {
+  public readonly id = 'PackParseError';
+
+  constructor(
+    message: string,
+    pkgManager: string | StaticPkgManagerSpec,
+    workspace: WorkspaceInfo,
+    error: SyntaxError,
+    output: string,
+  ) {
+    const pmSpec = isString(pkgManager) ? pkgManager : pkgManager.spec;
+    super(message, {pkgManager: pmSpec, output, workspace}, error);
+  }
+}

packages/midnight-smoker/src/error/pkg-manager.ts

@@ -4,7 +4,11 @@ export {InstallError} from '#error/install-error';
 
 export {InvalidArgError} from '#error/invalid-arg-error';
 
-export {PackError, PackParseError} from '#error/pack-error';
+export {PackError} from '#error/pack-error';
+
+export {PackParseError} from '#error/pack-parse-error';
+
+export {RuleError} from '#error/rule-error';
 
 export {RunScriptError} from '#error/run-script-error';
 

packages/midnight-smoker/src/error/rule-error.ts

@@ -1,25 +1,20 @@
-import type {StaticRuleContext} from '#schema/rule-static';
+import {type LintManifest} from '#schema/lint-manifest';
+import {type SomeRuleConfig} from '#schema/rule-options';
+import {type Result} from '#schema/workspaces';
+import {type Simplify} from 'type-fest';
 import {BaseSmokerError} from './base-error';
 
+export type RuleErrorContext = Simplify<
+  Result<LintManifest> & {
+    config: SomeRuleConfig;
+    ruleId: string;
+  }
+>;
+
 /**
  * @group Errors
  */
 
-export class RuleError extends BaseSmokerError<
-  {
-    context: StaticRuleContext;
-    ruleId: string;
-  },
-  Error
-> {
+export class RuleError extends BaseSmokerError<RuleErrorContext, Error> {
   public readonly id = 'RuleError';
-
-  constructor(
-    message: string,
-    context: StaticRuleContext,
-    ruleId: string,
-    error: Error,
-  ) {
-    super(message, {context, ruleId}, error);
-  }
 }

packages/midnight-smoker/src/error/smoke-error.ts

@@ -7,7 +7,7 @@
 import {type LintResult} from '#schema/lint-result';
 import {type RunScriptResult} from '#schema/run-script-result';
 import {castArray} from '#util/util';
-import {AggregateSmokerError} from './base-error';
+import {AggregateSmokerError} from './aggregate-smoker-error';
 
 /**
  * Thrown when _anything_ in `Smoker.smoke()` fails.

packages/midnight-smoker/src/error/some-pack-error.ts

@@ -0,0 +1,4 @@
+import {type PackError} from './pack-error';
+import {type PackParseError} from './pack-parse-error';
+
+export type SomePackError = PackError | PackParseError;

packages/midnight-smoker/src/error/temp-dir-error.ts

@@ -6,16 +6,13 @@ import {BaseSmokerError} from './base-error';
  * @group Errors
  */
 
-export class TempDirError extends BaseSmokerError<
-  {spec: string},
-  NodeJS.ErrnoException
-> {
+export class TempDirError extends BaseSmokerError<{spec: string}, Error> {
   public readonly id = 'TempDirError';
 
   constructor(
     message: string,
     spec: string | StaticPkgManagerSpec,
-    error: NodeJS.ErrnoException,
+    error: Error,
   ) {
     super(message, {spec: isString(spec) ? spec : spec.spec}, error);
   }

packages/midnight-smoker/src/event/pack-events.ts

@@ -1,8 +1,10 @@
-import {type PackError, type PackParseError} from '#error/pack-error';
+import {type PackError} from '#error/pack-error';
+import {type SomePackError} from '#error/some-pack-error';
 import {type InstallManifest} from '#schema/install-manifest';
 import {type PackOptions} from '#schema/pack-options';
 import {type StaticPkgManagerSpec} from '#schema/static-pkg-manager-spec';
 import {type Result, type WorkspaceInfo} from '#schema/workspaces';
+import {type PackParseError} from '../error/pack-parse-error';
 import type {PackEvent} from './event-constants';
 import type {PkgManagerEventBase} from './pkg-manager-events';
 
@@ -70,7 +72,7 @@ export interface PkgManagerPackBeginEventData
 
 export interface PkgManagerPackFailedEventData
   extends PkgManagerPackEventDataBase {
-  error: PackError | PackParseError;
+  error: SomePackError;
 }
 
 export interface PkgManagerPackOkEventData extends PkgManagerPackEventDataBase {
@@ -88,5 +90,5 @@ export interface PackBeginEventData extends PackEventDataBase {}
 export interface PackOkEventData extends PackEventDataBase {}
 
 export interface PackFailedEventData extends PackEventDataBase {
-  error: PackError | PackParseError;
+  error: SomePackError;
 }