@systemfsoftware/stryker-js-typescript-checker 1.4.1 → 3.0.0

package/CHANGELOG.md

@@ -1,5 +1,100 @@
 # @systemfsoftware/stryker-js-typescript-checker
 
+## 3.0.0
+
+### Major Changes
+
+- Three packages are renamed. `plugin-api` is now `@systemfsoftware/stryker-js`, the
+  language every plugin is written against. `mutation-run` is now
+  `@systemfsoftware/stryker-js-platform-node`, the Node host that runs a mutation
+  test. `mutation-report` is now `@systemfsoftware/stryker-js-html-reporter`.
+  Install the new names and change your imports.
+
+  Options types moved. `StrykerOptions`, `PartialStrykerOptions` and `LogLevel` are
+  imported from the `Schema` export; `Mutant`, `MutantStatus`, `Position` and
+  `Location` from the `Mutant` export. Point a config's `extends` at the language
+  package's `Schema` export.
+
+  `MutantStatus` accepts one spelling per outcome: `Killed`, `Survived`,
+  `NoCoverage`, `Timeout`, `CompileError`, `RuntimeError`, `Ignored` and `Pending`.
+  The lowercase and abbreviated forms — `killed`, `timedOut`, `noCoverage` and the
+  rest — are gone. A comparison against a removed spelling never matched the value
+  the reporter actually produced, so check any status comparison you wrote.
+
+  Statuses, plugin kinds, exit classes and AST formats are string literal unions
+  rather than enums, so read them as their string values. Member access such as
+  `ExitClass.VerdictFail` no longer resolves.
+
+  A plugin no longer receives a logger, and the logger port is gone. Plugins log
+  through Effect, and the host decides where that output goes.
+
+  The bundled base preset is gone. A config inherits from the language package's
+  `Schema` export and states the thresholds, reporters and plugins it wants; you no
+  longer silently inherit a package manager, a plugin list or a break threshold.
+
+### Patch Changes
+
+- A type error inside an installed dependency's declaration files no longer fails the run.
+
+  The checker exists to decide whether your source still compiles once a mutant is
+  applied. It was also reporting errors from `.d.ts` files inside installed packages —
+  most often a package whose optional peer dependency is not installed. No mutant
+  causes those, every mutant reports the same ones, and the checker cannot act on
+  them, so their only effect was to end the run before a single mutant was tested.
+
+  Library declaration files are now skipped, alongside the code-quality options the
+  checker already relaxes while mutating.
+
+- An oversized message between the runner and a worker now fails the run with a
+  reason instead of exhausting memory. Each side of the connection reads frames
+  up to 16 MiB, which leaves headroom over the largest legitimate payload — a dry
+  run carrying per-test coverage — and a frame past the limit fails the calls
+  waiting on it rather than growing until the process dies.
+
+- Updated dependencies:
+  - @systemfsoftware/effect-cell-types@5.0.0
+
+## 2.0.0
+
+### Major Changes
+
+- The TypeScript compiler's methods return Effects instead of Promises, and the
+  compiler is acquired for the length of the check. An interrupted check now
+  releases the compiler instead of leaving it alive with the run's state still in
+  it.
+
+  Compiler failures are now a single tagged `CompilerFailed` error carrying a
+  `reason` — the compiler used before initialization, no projects found for the
+  tsconfig, an unknown file in the graph, or a project file missing from disk.
+  They were untagged `Error`s before, so anything catching them saw one
+  indistinguishable type.
+
+  Diagnostics and `tsconfig` resolution are unchanged.
+
+### Patch Changes
+
+- The shared helpers package is gone. Nothing installs it any more, and the
+  handful of helpers worth sharing now live in the plugin contract next to the
+  types they serve:
+
+  - `strykerReportBugUrl`, `normalizeFileName`, `propertyPath`, `errorToString`
+    and `isErrnoException` from `@systemfsoftware/stryker-js-plugin-api/core`
+  - `noopLogger` from `@systemfsoftware/stryker-js-plugin-api/logging`
+  - `testFilesProvided` from `@systemfsoftware/stryker-js-plugin-api/test-runner`
+
+  If you imported any of those, change the specifier. Everything else it exported
+  had no consumer and is removed: use `Predicate.isNotNullish` from Effect in place
+  of `notEmpty`, and `RegExp.escape` in place of `escapeRegExp`.
+
+- These packages no longer install dependencies they never imported, so installing them pulls less into your tree.
+
+  `tslib` is gone from all six. The mutation runner additionally stops installing `lodash.groupby`, `semver` and `source-map`, and the command line interface stops installing `@effect/platform-node-shared`. Nothing exported changes.
+
+- Published packages no longer carry build artifacts left over from earlier builds. One package was shipping about a megabyte of bundled test-runner internals this way.
+
+- Updated dependencies:
+  - @systemfsoftware/stryker-js-plugin-api@3.0.0
+
 ## 1.4.1
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,122 +1,5 @@
-import { PluginKind } from "@systemfsoftware/stryker-js-plugin-api/plugin";
-import { CheckResult, Checker } from "@systemfsoftware/stryker-js-plugin-api/check";
-import { Diagnostic } from "typescript/unstable/sync";
-import { Mutant, StrykerOptions } from "@systemfsoftware/stryker-js-plugin-api/core";
-import { Logger } from "@systemfsoftware/stryker-js-plugin-api/logging";
-import { FileSystem, FileSystemEntries } from "typescript/unstable/fs";
-//#region src/grouping/ts-file-node.d.ts
-declare class TSFileNode {
-  fileName: string;
-  parents: TSFileNode[];
-  children: TSFileNode[];
-  constructor(fileName: string, parents: TSFileNode[], children: TSFileNode[]);
-  getAllParentReferencesIncludingSelf(allParentReferences?: Set<TSFileNode>): Set<TSFileNode>;
-  getAllChildReferencesIncludingSelf(allChildReferences?: Set<TSFileNode>): Set<TSFileNode>;
-  getMutantsWithReferenceToChildrenOrSelf(mutants: Mutant[], nodesChecked?: string[]): Mutant[];
-}
-//#endregion
-//#region src/project/script-file.d.ts
-declare class ScriptFile {
-  content: string;
-  fileName: string;
-  modifiedTime: Date;
-  private readonly originalContent;
-  constructor(content: string, fileName: string, modifiedTime?: Date);
-  write(content: string): void;
-  mutate(mutant: Pick<Mutant, 'location' | 'replacement'>): void;
-  private getOffset;
-  resetMutant(): void;
-  private touch;
-}
-//#endregion
-//#region src/project/hybrid-file-system.d.ts
-/**
- * A very simple hybrid file system.
- * * Readonly from disk
- * * Writes in-memory
- * * Hard caching
- * * Ability to mutate one file
- */
-declare class HybridFileSystem implements FileSystem {
-  private readonly files;
-  /**
-   * Map of absolute tsconfig file paths to their adjusted JSON content.
-   * This allows the TS7 API to read overridden compiler options.
-   */
-  tsConfigOverrides: Map<string, string>;
-  readFile: (fileName: string) => string | null | undefined;
-  fileExists: (fileName: string) => boolean | undefined;
-  directoryExists: () => boolean | undefined;
-  getAccessibleEntries: () => FileSystemEntries | undefined;
-  realpath: () => string | undefined;
-  writeFile(fileName: string, data: string): void;
-  getFile(fileName: string): ScriptFile | undefined;
-  mutateFile(fileName: string, mutant: Parameters<ScriptFile['mutate']>[0]): void;
-  resetFile(fileName: string): void;
-  existsInMemory(fileName: string): boolean;
-  private fileNameIsBuildInfo;
-}
-//#endregion
-//#region src/typescript-compiler.d.ts
-interface ITypescriptCompiler {
-  init(): Promise<Diagnostic[]>;
-  check(mutants: Mutant[]): Promise<Diagnostic[]>;
-}
-interface IFileRelationCreator {
-  get nodes(): Map<string, TSFileNode>;
-}
-declare class TypescriptCompiler implements ITypescriptCompiler, IFileRelationCreator {
-  private readonly log;
-  private readonly options;
-  private readonly fs;
-  static inject: ["logger", "options", "fs"];
-  private readonly allTSConfigFiles;
-  private readonly tsconfigFile;
-  private api?;
-  private snapshot?;
-  private readonly sourceFiles;
-  private readonly _nodes;
-  private lastMutants;
-  private lastMutatedFileNames;
-  constructor(log: Logger, options: StrykerOptions, fs: HybridFileSystem);
-  init(): Promise<Diagnostic[]>;
-  check(mutants: Mutant[]): Promise<Diagnostic[]>;
-  get nodes(): Map<string, TSFileNode>;
-  close(): void;
-  getLineAndCharacterOfPosition(fileName: string, position: number): {
-    line: number;
-    character: number;
-  } | undefined;
-  private getPrograms;
-  private collectAllTSConfigFiles;
-  private buildDependencyGraph;
-  private extractImports;
-  private resolveModuleSpecifier;
-  private getResolutionCandidates;
-  private resolveTSInputFile;
-  private guardTSConfigFileExists;
-}
-//#endregion
-//#region src/typescript-checker.d.ts
-declare class TypescriptChecker implements Checker {
-  private readonly logger;
-  private readonly tsCompiler;
-  static inject: ["logger", "options", "tsCompiler"];
-  private readonly options;
-  constructor(logger: Logger, options: StrykerOptions, tsCompiler: TypescriptCompiler);
-  init(): Promise<void>;
-  check(mutants: Mutant[]): Promise<Record<string, CheckResult>>;
-  group(mutants: Mutant[]): Promise<string[][]>;
-  private checkErrors;
-  private createErrorText;
-  private formatDiagnostic;
-}
-//#endregion
 //#region src/index.d.ts
-declare const strykerPlugins: import("@systemfsoftware/stryker-js-plugin-api/plugin").FactoryPlugin<PluginKind.Checker, ["$injector"]>[];
-declare const createTypescriptChecker: ((injector: import("@systemfsoftware/stryker-js-plugin-api/plugin").Injector<import("@systemfsoftware/stryker-js-plugin-api/plugin").PluginContext>) => TypescriptChecker) & {
-  inject: ["$injector"];
-};
+declare const strykerPlugins: import("@systemfsoftware/stryker-js/Plugin").PluginContribution<"Checker">[];
 declare const strykerValidationSchema: Record<string, unknown>;
 //#endregion
-export { createTypescriptChecker, strykerPlugins, strykerValidationSchema };
+export { strykerPlugins, strykerValidationSchema };