@as-pect/json-reporter 8.1.0 → 9.0.0

package/CHANGELOG.md

@@ -0,0 +1,16 @@
+# @as-pect/json-reporter
+
+## 9.0.0
+
+### Patch Changes
+
+- fdd7f20: Add a dedicated CTRF JSON reporter package and `asp --ctrf` shortcut while documenting that `asp --json` remains the as-pect legacy JSON v1 contract.
+- 65058fe: Share file-backed reporter output behavior across CSV and JSON reporters while preserving existing output paths and formats.
+- 5abb0e1: Treat groups and tests skipped by `--group` or `--test` filters as skipped instead of failed, and suppress per-file reports and aggregate counts for files with no executed results.
+- dd71792: Anchor built-in file-backed reporter output to the Test session project path, and allow programmatic reporter users to pass an explicit output root.
+- Updated dependencies [dbaaae5]
+- Updated dependencies [65058fe]
+- Updated dependencies [5abb0e1]
+- Updated dependencies [4420210]
+  - @as-pect/core@9.0.0
+  - @as-pect/reporter-output@9.0.0

package/__tests__/JSONReporter.spec.ts

@@ -0,0 +1,295 @@
+import { access, mkdir, mkdtemp, readFile, rm } from "fs/promises";
+import { join, relative } from "path";
+import JSONReporter from "../index.js";
+import type { SuiteReport, SuiteResultReport } from "@as-pect/core";
+
+class TestJSONReporter extends JSONReporter {
+  public async writeAndWait(report: Pick<SuiteReport, "fileName" | "hasResults" | "results">): Promise<void> {
+    this.onReportFinish({ report: report as SuiteReport });
+    await this.onFlush();
+  }
+}
+
+function testResult(overrides: Partial<SuiteResultReport> = {}): SuiteResultReport {
+  return {
+    type: "test",
+    groupName: "math",
+    name: "adds values",
+    ran: true,
+    negated: false,
+    pass: true,
+    runtime: 3,
+    message: null,
+    stackTrace: null,
+    rtraceDelta: 0,
+    logs: [],
+    actual: "3",
+    expected: "3",
+    actualValue: null,
+    expectedValue: null,
+    ...overrides,
+  } as SuiteResultReport;
+}
+
+async function reporterCreatesFile(report: Pick<SuiteReport, "hasResults" | "results">): Promise<boolean> {
+  const tempDir = await mkdtemp(join(process.cwd(), "tmp-json-reporter-"));
+  const fileName = join(relative(process.cwd(), tempDir), "example.spec.ts");
+  const reporter = new TestJSONReporter();
+  const outputPath = join(tempDir, "example.spec.json");
+
+  try {
+    await reporter.writeAndWait({ fileName, ...report });
+    await access(outputPath);
+    return true;
+  } catch {
+    return false;
+  } finally {
+    await rm(tempDir, { recursive: true, force: true });
+  }
+}
+
+async function runReporter(results: SuiteResultReport[]): Promise<unknown> {
+  const tempDir = await mkdtemp(join(process.cwd(), "tmp-json-reporter-"));
+  const fileName = join(relative(process.cwd(), tempDir), "example.spec.ts");
+  const reporter = new TestJSONReporter();
+
+  try {
+    await reporter.writeAndWait({ fileName, hasResults: true, results });
+    const output = await readFile(join(tempDir, "example.spec.json"), "utf8");
+    return JSON.parse(output);
+  } finally {
+    await rm(tempDir, { recursive: true, force: true });
+  }
+}
+
+async function runNestedReporter(): Promise<unknown> {
+  const tempDir = await mkdtemp(join(process.cwd(), "tmp-json-reporter-"));
+  const sourceDir = join(tempDir, "assembly", "__tests__");
+  const fileName = join(relative(process.cwd(), sourceDir), "entry.spec.ts");
+  const reporter = new TestJSONReporter();
+
+  try {
+    await mkdir(sourceDir, { recursive: true });
+    await reporter.writeAndWait({ fileName, hasResults: true, results: [testResult()] });
+    const output = await readFile(join(sourceDir, "entry.spec.json"), "utf8");
+    return JSON.parse(output);
+  } finally {
+    await rm(tempDir, { recursive: true, force: true });
+  }
+}
+
+async function runProjectRootReporter(): Promise<unknown> {
+  const tempDir = await mkdtemp(join(process.cwd(), "tmp-json-reporter-root-"));
+  const sourceDir = join(tempDir, "assembly", "__tests__");
+  const reporter = new TestJSONReporter(tempDir);
+
+  try {
+    await mkdir(sourceDir, { recursive: true });
+    await reporter.writeAndWait({
+      fileName: "assembly/__tests__/entry.spec.ts",
+      hasResults: true,
+      results: [testResult()],
+    });
+    const output = await readFile(join(sourceDir, "entry.spec.json"), "utf8");
+    return JSON.parse(output);
+  } finally {
+    await rm(tempDir, { recursive: true, force: true });
+  }
+}
+
+async function writeReportWithMissingOutputDirectory(): Promise<void> {
+  const tempDir = await mkdtemp(join(process.cwd(), "tmp-json-reporter-"));
+  const fileName = join(relative(process.cwd(), tempDir), "missing", "entry.spec.ts");
+  const reporter = new TestJSONReporter();
+
+  try {
+    await reporter.writeAndWait({ fileName, hasResults: true, results: [testResult()] });
+  } finally {
+    await rm(tempDir, { recursive: true, force: true });
+  }
+}
+
+describe("JSONReporter", () => {
+  it("does not write a file for reports with no executed results", async () => {
+    await expect(
+      reporterCreatesFile({
+        hasResults: false,
+        results: [testResult({ name: "skipped by filter", ran: false })],
+      }),
+    ).resolves.toBe(false);
+  });
+
+  it("writes parseable JSON for an empty report", async () => {
+    await expect(runReporter([])).resolves.toEqual([]);
+  });
+
+  it("writes parseable JSON for one test result", async () => {
+    await expect(runReporter([testResult()])).resolves.toEqual([
+      {
+        group: "math",
+        name: "adds values",
+        ran: true,
+        pass: true,
+        negated: false,
+        runtime: 3,
+        message: null,
+        actual: "3",
+        expected: "3",
+      },
+    ]);
+  });
+
+  it("writes the JSON file next to a nested test entry", async () => {
+    await expect(runNestedReporter()).resolves.toEqual([
+      {
+        group: "math",
+        name: "adds values",
+        ran: true,
+        pass: true,
+        negated: false,
+        runtime: 3,
+        message: null,
+        actual: "3",
+        expected: "3",
+      },
+    ]);
+  });
+
+  it("writes project-relative report files under the configured output root", async () => {
+    await expect(runProjectRootReporter()).resolves.toEqual([
+      {
+        group: "math",
+        name: "adds values",
+        ran: true,
+        pass: true,
+        negated: false,
+        runtime: 3,
+        message: null,
+        actual: "3",
+        expected: "3",
+      },
+    ]);
+  });
+
+  it("surfaces output stream errors through flush", async () => {
+    await expect(writeReportWithMissingOutputDirectory()).rejects.toMatchObject({ code: "ENOENT" });
+  });
+
+  it("preserves the as-pect legacy JSON v1 shape for pass, fail, and todo results", async () => {
+    await expect(
+      runReporter([
+        testResult({ name: "adds values", runtime: 3 }),
+        testResult({
+          name: "subtracts values",
+          pass: false,
+          runtime: 5,
+          message: "expected 1",
+          actual: "2",
+          expected: "1",
+        }),
+        {
+          type: "todo",
+          groupName: "math",
+          description: "handles division",
+        },
+      ]),
+    ).resolves.toEqual([
+      {
+        group: "math",
+        name: "adds values",
+        ran: true,
+        pass: true,
+        negated: false,
+        runtime: 3,
+        message: null,
+        actual: "3",
+        expected: "3",
+      },
+      {
+        group: "math",
+        name: "subtracts values",
+        ran: true,
+        pass: false,
+        negated: false,
+        runtime: 5,
+        message: "expected 1",
+        actual: "2",
+        expected: "1",
+      },
+      {
+        group: "math",
+        name: "TODO: handles division",
+        ran: false,
+        pass: null,
+        negated: false,
+        runtime: 0,
+        message: "",
+        actual: null,
+        expected: null,
+      },
+    ]);
+  });
+
+  it("writes parseable JSON for multiple test results", async () => {
+    await expect(
+      runReporter([
+        testResult({ name: "adds values", runtime: 3 }),
+        testResult({
+          name: "subtracts values",
+          pass: false,
+          runtime: 5,
+          message: "expected 1",
+          actual: "2",
+          expected: "1",
+        }),
+      ]),
+    ).resolves.toEqual([
+      {
+        group: "math",
+        name: "adds values",
+        ran: true,
+        pass: true,
+        negated: false,
+        runtime: 3,
+        message: null,
+        actual: "3",
+        expected: "3",
+      },
+      {
+        group: "math",
+        name: "subtracts values",
+        ran: true,
+        pass: false,
+        negated: false,
+        runtime: 5,
+        message: "expected 1",
+        actual: "2",
+        expected: "1",
+      },
+    ]);
+  });
+
+  it("writes parseable JSON for a todo result", async () => {
+    await expect(
+      runReporter([
+        {
+          type: "todo",
+          groupName: "math",
+          description: "handles division",
+        },
+      ]),
+    ).resolves.toEqual([
+      {
+        group: "math",
+        name: "TODO: handles division",
+        ran: false,
+        pass: null,
+        negated: false,
+        runtime: 0,
+        message: "",
+        actual: null,
+        expected: null,
+      },
+    ]);
+  });
+});

package/index.ts

@@ -1,6 +1,6 @@
-import { WriteStream, createWriteStream } from "fs";
-import { basename, extname, dirname, join } from "path";
-import { TestNodeType, TestContext, IReporter, TestNode, IWritable } from "@as-pect/core";
+import { Writable } from "stream";
+import { TestContext, IReporter, IWritable, SuiteReport, SuiteReportEvent, SuiteResultReport } from "@as-pect/core";
+import { ReporterFileOutput } from "@as-pect/reporter-output";
 
 /**
  * This class reports all relevant test statistics to a JSON file located at
@@ -10,74 +10,80 @@ export default class JSONReporter implements IReporter {
   public stdout: IWritable | null = null;
   public stderr: IWritable | null = null;
 
-  protected file: WriteStream | null = null;
+  protected file: Writable | null = null;
+  protected fileOutput: ReporterFileOutput;
 
   private first: boolean = true;
 
-  public onEnter(ctx: TestContext): void {
-    const extension = extname(ctx.fileName);
-    const dir = dirname(ctx.fileName);
-    const base = basename(ctx.fileName, extension);
-    const outPath = join(process.cwd(), dir, base + ".json");
-    this.file = createWriteStream(outPath, "utf8");
-    this.file.write("[");
-    this.first = true;
+  public constructor(outputRoot?: string) {
+    this.fileOutput = new ReporterFileOutput(undefined, outputRoot);
   }
 
-  public onExit(_ctx: TestContext, node: TestNode): void {
-    if (node.type === TestNodeType.Group) {
-      this.onGroupFinish(node);
-    }
+  public onEnter(_ctx: TestContext): void {}
+
+  public onExit(_ctx: TestContext): void {}
+
+  public onReportFinish(event: SuiteReportEvent): void {
+    this.writeReport(event.report);
   }
 
-  public onFinish(_ctx: TestContext): void {
-    this.file!.end();
+  public onFinish(ctx: TestContext): void {
+    this.writeReport(SuiteReport.from(ctx));
   }
 
-  protected onGroupFinish(group: TestNode) {
-    if (group.children.length === 0) return;
+  public onFlush(): Promise<void> {
+    return this.fileOutput.flush();
+  }
+
+  protected writeReport(report: SuiteReport): void {
+    if (report.hasResults === false) return;
+
+    const fileReport = this.fileOutput.start(report, ".json");
+    if (fileReport === null) return;
 
-    group.groupTests.forEach((test) => this.onTestFinish(group, test));
-    group.groupTodos.forEach((desc) => this.onTodo(group, desc));
+    const file = fileReport.stream;
+    this.file = file;
+    file.write("[");
+    this.first = true;
+
+    for (const result of report.results) {
+      this.onResult(result);
+    }
+
+    file.write(this.first ? "]" : "\n]");
+    file.end();
   }
 
-  protected onTestFinish(group: TestNode, test: TestNode): void {
-    this.file!.write(
-      (this.first ? "\n" : ",\n") +
-        JSON.stringify({
-          group: group.name,
-          name: test.name,
-          ran: test.ran,
-          pass: test.pass,
-          negated: test.negated,
-          runtime: test.deltaT,
-          message: test.message,
-          actual: test.actual ? test.actual.stringify({ indent: 0 }) : null,
-          expected: test.expected
-            ? `${test.negated ? "Not " : ""}${test.expected.stringify({
-                indent: 0,
-              })}`
-            : null,
-        }),
-    );
-    this.first = false;
+  protected onResult(result: SuiteResultReport): void {
+    if (result.type === "test") {
+      this.writeResult({
+        group: result.groupName,
+        name: result.name,
+        ran: result.ran,
+        pass: result.pass,
+        negated: result.negated,
+        runtime: result.runtime,
+        message: result.message,
+        actual: result.actual,
+        expected: result.expected,
+      });
+    } else {
+      this.writeResult({
+        group: result.groupName,
+        name: "TODO: " + result.description,
+        ran: false,
+        pass: null,
+        negated: false,
+        runtime: 0,
+        message: "",
+        actual: null,
+        expected: null,
+      });
+    }
   }
 
-  protected onTodo(group: TestNode, desc: string) {
-    this.file!.write(
-      (this.first ? "\n" : ",\n") +
-        JSON.stringify({
-          group: group.name,
-          name: "TODO: " + desc,
-          ran: false,
-          pass: null,
-          negated: false,
-          runtime: 0,
-          message: "",
-          actual: null,
-          expected: null,
-        }),
-    );
+  protected writeResult(result: object): void {
+    this.file!.write((this.first ? "\n" : ",\n") + JSON.stringify(result));
     this.first = false;
   }
-};
+}

package/jest.config.js

@@ -0,0 +1,17 @@
+import { resolve } from "path";
+
+export default {
+  testEnvironment: "node",
+  transform: {
+    "^.+\\.tsx?$": ["ts-jest", { useESM: true }],
+  },
+  testMatch: ["**/__tests__/**/*.spec.[jt]s"],
+  testPathIgnorePatterns: ["/node_modules/"],
+  extensionsToTreatAsEsm: [".ts"],
+  moduleNameMapper: {
+    "^(\\.{1,2}/.*)\\.js$": "$1",
+    "^@as-pect/core$": resolve("../core/src/index.ts"),
+    "^@as-pect/reporter-output$": resolve("../reporter-output/index.ts"),
+    "^@as-pect/snapshots$": resolve("../snapshots/src/index.ts"),
+  },
+};

package/lib/index.d.ts

@@ -1,6 +1,6 @@
-/// <reference types="node" />
-import { WriteStream } from "fs";
-import { TestContext, IReporter, TestNode, IWritable } from "@as-pect/core";
+import { Writable } from "stream";
+import { TestContext, IReporter, IWritable, SuiteReport, SuiteReportEvent, SuiteResultReport } from "@as-pect/core";
+import { ReporterFileOutput } from "@as-pect/reporter-output";
 /**
  * This class reports all relevant test statistics to a JSON file located at
  * `{testLocation}.spec.json`.
@@ -8,13 +8,17 @@ import { TestContext, IReporter, TestNode, IWritable } from "@as-pect/core";
 export default class JSONReporter implements IReporter {
     stdout: IWritable | null;
     stderr: IWritable | null;
-    protected file: WriteStream | null;
+    protected file: Writable | null;
+    protected fileOutput: ReporterFileOutput;
     private first;
-    onEnter(ctx: TestContext): void;
-    onExit(_ctx: TestContext, node: TestNode): void;
-    onFinish(_ctx: TestContext): void;
-    protected onGroupFinish(group: TestNode): void;
-    protected onTestFinish(group: TestNode, test: TestNode): void;
-    protected onTodo(group: TestNode, desc: string): void;
+    constructor(outputRoot?: string);
+    onEnter(_ctx: TestContext): void;
+    onExit(_ctx: TestContext): void;
+    onReportFinish(event: SuiteReportEvent): void;
+    onFinish(ctx: TestContext): void;
+    onFlush(): Promise<void>;
+    protected writeReport(report: SuiteReport): void;
+    protected onResult(result: SuiteResultReport): void;
+    protected writeResult(result: object): void;
 }
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,WAAW,EAAqB,MAAM,IAAI,CAAC;AAEpD,OAAO,EAAgB,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1F;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,YAAa,YAAW,SAAS;IAC7C,MAAM,EAAE,SAAS,GAAG,IAAI,CAAQ;IAChC,MAAM,EAAE,SAAS,GAAG,IAAI,CAAQ;IAEvC,SAAS,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI,CAAQ;IAE1C,OAAO,CAAC,KAAK,CAAiB;IAEvB,OAAO,CAAC,GAAG,EAAE,WAAW,GAAG,IAAI;IAU/B,MAAM,CAAC,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,GAAG,IAAI;IAM/C,QAAQ,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI;IAIxC,SAAS,CAAC,aAAa,CAAC,KAAK,EAAE,QAAQ;IAOvC,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,GAAG,IAAI;IAsB7D,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM;CAiB/C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAClC,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,gBAAgB,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACpH,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAE9D;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,YAAa,YAAW,SAAS;IAC7C,MAAM,EAAE,SAAS,GAAG,IAAI,CAAQ;IAChC,MAAM,EAAE,SAAS,GAAG,IAAI,CAAQ;IAEvC,SAAS,CAAC,IAAI,EAAE,QAAQ,GAAG,IAAI,CAAQ;IACvC,SAAS,CAAC,UAAU,EAAE,kBAAkB,CAAC;IAEzC,OAAO,CAAC,KAAK,CAAiB;gBAEX,UAAU,CAAC,EAAE,MAAM;IAI/B,OAAO,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI;IAEhC,MAAM,CAAC,IAAI,EAAE,WAAW,GAAG,IAAI;IAE/B,cAAc,CAAC,KAAK,EAAE,gBAAgB,GAAG,IAAI;IAI7C,QAAQ,CAAC,GAAG,EAAE,WAAW,GAAG,IAAI;IAIhC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAI/B,SAAS,CAAC,WAAW,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI;IAmBhD,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,iBAAiB,GAAG,IAAI;IA4BnD,SAAS,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;CAI5C"}

package/lib/index.js

@@ -1,5 +1,5 @@
-import { createWriteStream } from "fs";
-import { basename, extname, dirname, join } from "path";
+import { SuiteReport } from "@as-pect/core";
+import { ReporterFileOutput } from "@as-pect/reporter-output";
 /**
  * This class reports all relevant test statistics to a JSON file located at
  * `{testLocation}.spec.json`.
@@ -8,54 +8,56 @@ export default class JSONReporter {
     stdout = null;
     stderr = null;
     file = null;
+    fileOutput;
     first = true;
-    onEnter(ctx) {
-        const extension = extname(ctx.fileName);
-        const dir = dirname(ctx.fileName);
-        const base = basename(ctx.fileName, extension);
-        const outPath = join(process.cwd(), dir, base + ".json");
-        this.file = createWriteStream(outPath, "utf8");
-        this.file.write("[");
-        this.first = true;
+    constructor(outputRoot) {
+        this.fileOutput = new ReporterFileOutput(undefined, outputRoot);
     }
-    onExit(_ctx, node) {
-        if (node.type === 1 /* TestNodeType.Group */) {
-            this.onGroupFinish(node);
-        }
+    onEnter(_ctx) { }
+    onExit(_ctx) { }
+    onReportFinish(event) {
+        this.writeReport(event.report);
     }
-    onFinish(_ctx) {
-        this.file.end();
+    onFinish(ctx) {
+        this.writeReport(SuiteReport.from(ctx));
     }
-    onGroupFinish(group) {
-        if (group.children.length === 0)
-            return;
-        group.groupTests.forEach((test) => this.onTestFinish(group, test));
-        group.groupTodos.forEach((desc) => this.onTodo(group, desc));
+    onFlush() {
+        return this.fileOutput.flush();
     }
-    onTestFinish(group, test) {
-        this.file.write((this.first ? "\n" : ",\n") +
-            JSON.stringify({
-                group: group.name,
-                name: test.name,
-                ran: test.ran,
-                pass: test.pass,
-                negated: test.negated,
-                runtime: test.deltaT,
-                message: test.message,
-                actual: test.actual ? test.actual.stringify({ indent: 0 }) : null,
-                expected: test.expected
-                    ? `${test.negated ? "Not " : ""}${test.expected.stringify({
-                        indent: 0,
-                    })}`
-                    : null,
-            }));
-        this.first = false;
+    writeReport(report) {
+        if (report.hasResults === false)
+            return;
+        const fileReport = this.fileOutput.start(report, ".json");
+        if (fileReport === null)
+            return;
+        const file = fileReport.stream;
+        this.file = file;
+        file.write("[");
+        this.first = true;
+        for (const result of report.results) {
+            this.onResult(result);
+        }
+        file.write(this.first ? "]" : "\n]");
+        file.end();
     }
-    onTodo(group, desc) {
-        this.file.write((this.first ? "\n" : ",\n") +
-            JSON.stringify({
-                group: group.name,
-                name: "TODO: " + desc,
+    onResult(result) {
+        if (result.type === "test") {
+            this.writeResult({
+                group: result.groupName,
+                name: result.name,
+                ran: result.ran,
+                pass: result.pass,
+                negated: result.negated,
+                runtime: result.runtime,
+                message: result.message,
+                actual: result.actual,
+                expected: result.expected,
+            });
+        }
+        else {
+            this.writeResult({
+                group: result.groupName,
+                name: "TODO: " + result.description,
                 ran: false,
                 pass: null,
                 negated: false,
@@ -63,9 +65,12 @@ export default class JSONReporter {
                 message: "",
                 actual: null,
                 expected: null,
-            }));
+            });
+        }
+    }
+    writeResult(result) {
+        this.file.write((this.first ? "\n" : ",\n") + JSON.stringify(result));
         this.first = false;
     }
 }
-;
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,iBAAiB,EAAE,MAAM,IAAI,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAGxD;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,YAAY;IACxB,MAAM,GAAqB,IAAI,CAAC;IAChC,MAAM,GAAqB,IAAI,CAAC;IAE7B,IAAI,GAAuB,IAAI,CAAC;IAElC,KAAK,GAAY,IAAI,CAAC;IAEvB,OAAO,CAAC,GAAgB;QAC7B,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QACxC,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAClC,MAAM,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC,QAAQ,EAAE,SAAS,CAAC,CAAC;QAC/C,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,GAAG,EAAE,IAAI,GAAG,OAAO,CAAC,CAAC;QACzD,IAAI,CAAC,IAAI,GAAG,iBAAiB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAC/C,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAEM,MAAM,CAAC,IAAiB,EAAE,IAAc;QAC7C,IAAI,IAAI,CAAC,IAAI,+BAAuB,EAAE;YACpC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;SAC1B;IACH,CAAC;IAEM,QAAQ,CAAC,IAAiB;QAC/B,IAAI,CAAC,IAAK,CAAC,GAAG,EAAE,CAAC;IACnB,CAAC;IAES,aAAa,CAAC,KAAe;QACrC,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QAExC,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;QACnE,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC;IAC/D,CAAC;IAES,YAAY,CAAC,KAAe,EAAE,IAAc;QACpD,IAAI,CAAC,IAAK,CAAC,KAAK,CACd,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;YACzB,IAAI,CAAC,SAAS,CAAC;gBACb,KAAK,EAAE,KAAK,CAAC,IAAI;gBACjB,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,GAAG,EAAE,IAAI,CAAC,GAAG;gBACb,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,OAAO,EAAE,IAAI,CAAC,MAAM;gBACpB,OAAO,EAAE,IAAI,CAAC,OAAO;gBACrB,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI;gBACjE,QAAQ,EAAE,IAAI,CAAC,QAAQ;oBACrB,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;wBACtD,MAAM,EAAE,CAAC;qBACV,CAAC,EAAE;oBACN,CAAC,CAAC,IAAI;aACT,CAAC,CACL,CAAC;QACF,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAES,MAAM,CAAC,KAAe,EAAE,IAAY;QAC5C,IAAI,CAAC,IAAK,CAAC,KAAK,CACd,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC;YACzB,IAAI,CAAC,SAAS,CAAC;gBACb,KAAK,EAAE,KAAK,CAAC,IAAI;gBACjB,IAAI,EAAE,QAAQ,GAAG,IAAI;gBACrB,GAAG,EAAE,KAAK;gBACV,IAAI,EAAE,IAAI;gBACV,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,CAAC;gBACV,OAAO,EAAE,EAAE;gBACX,MAAM,EAAE,IAAI;gBACZ,QAAQ,EAAE,IAAI;aACf,CAAC,CACL,CAAC;QACF,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF;AAAA,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AACA,OAAO,EAAqC,WAAW,EAAuC,MAAM,eAAe,CAAC;AACpH,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAE9D;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,YAAY;IACxB,MAAM,GAAqB,IAAI,CAAC;IAChC,MAAM,GAAqB,IAAI,CAAC;IAE7B,IAAI,GAAoB,IAAI,CAAC;IAC7B,UAAU,CAAqB;IAEjC,KAAK,GAAY,IAAI,CAAC;IAE9B,YAAmB,UAAmB;QACpC,IAAI,CAAC,UAAU,GAAG,IAAI,kBAAkB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IAClE,CAAC;IAEM,OAAO,CAAC,IAAiB,IAAS,CAAC;IAEnC,MAAM,CAAC,IAAiB,IAAS,CAAC;IAElC,cAAc,CAAC,KAAuB;QAC3C,IAAI,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACjC,CAAC;IAEM,QAAQ,CAAC,GAAgB;QAC9B,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;IAC1C,CAAC;IAEM,OAAO;QACZ,OAAO,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC;IACjC,CAAC;IAES,WAAW,CAAC,MAAmB;QACvC,IAAI,MAAM,CAAC,UAAU,KAAK,KAAK;YAAE,OAAO;QAExC,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAC1D,IAAI,UAAU,KAAK,IAAI;YAAE,OAAO;QAEhC,MAAM,IAAI,GAAG,UAAU,CAAC,MAAM,CAAC;QAC/B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAChB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;QAElB,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACpC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACxB,CAAC;QAED,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QACrC,IAAI,CAAC,GAAG,EAAE,CAAC;IACb,CAAC;IAES,QAAQ,CAAC,MAAyB;QAC1C,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YAC3B,IAAI,CAAC,WAAW,CAAC;gBACf,KAAK,EAAE,MAAM,CAAC,SAAS;gBACvB,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,GAAG,EAAE,MAAM,CAAC,GAAG;gBACf,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,OAAO,EAAE,MAAM,CAAC,OAAO;gBACvB,MAAM,EAAE,MAAM,CAAC,MAAM;gBACrB,QAAQ,EAAE,MAAM,CAAC,QAAQ;aAC1B,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,WAAW,CAAC;gBACf,KAAK,EAAE,MAAM,CAAC,SAAS;gBACvB,IAAI,EAAE,QAAQ,GAAG,MAAM,CAAC,WAAW;gBACnC,GAAG,EAAE,KAAK;gBACV,IAAI,EAAE,IAAI;gBACV,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,CAAC;gBACV,OAAO,EAAE,EAAE;gBACX,MAAM,EAAE,IAAI;gBACZ,QAAQ,EAAE,IAAI;aACf,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAES,WAAW,CAAC,MAAc;QAClC,IAAI,CAAC,IAAK,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;QACvE,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;CACF"}

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@as-pect/json-reporter",
-  "version": "8.1.0",
+  "version": "9.0.0",
   "description": "Json reporter for as-pect",
   "main": "lib/index.js",
-  "types": "lib/index.ts",
+  "types": "lib/index.d.ts",
   "type": "module",
   "scripts": {
     "tsc:all": "tsc",
-    "test": "exit 0"
+    "test": "node --experimental-vm-modules ../../node_modules/jest/bin/jest.js"
   },
   "repository": {
     "type": "git",
@@ -16,7 +16,10 @@
   "author": "Joshua Tenner",
   "license": "MIT",
   "dependencies": {
-    "@as-pect/core": "^8.1.0"
+    "@as-pect/core": "^9.0.0",
+    "@as-pect/reporter-output": "^9.0.0"
   },
-  "gitHead": "aa6aa77222efb41b3d9889ab190e452fa0f091c8"
+  "publishConfig": {
+    "access": "public"
+  }
 }

package/readme.md

@@ -1,9 +1,8 @@
 # jtenner/as-pect - @as-pect/json-reporter
 
-[![Greenkeeper badge](https://badges.greenkeeper.io/jtenner/as-pect.svg)](https://greenkeeper.io/)
-[![Build Status](https://travis-ci.org/jtenner/as-pect.svg?branch=master)](https://travis-ci.org/jtenner/as-pect)
+[![Test](https://github.com/jtenner/as-pect/actions/workflows/test.yml/badge.svg)](https://github.com/jtenner/as-pect/actions/workflows/test.yml)
 [![Coverage Status](https://coveralls.io/repos/github/jtenner/as-pect/badge.svg?branch=master)](https://coveralls.io/github/jtenner/as-pect?branch=master)
-[![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lerna.js.org/)
+[![Changesets](https://img.shields.io/badge/maintained%20with-changesets-176de3.svg)](https://github.com/changesets/changesets)
 
 Write your module in AssemblyScript and get blazing fast bootstrapped tests
 with WebAssembly speeds!
@@ -12,6 +11,52 @@ with WebAssembly speeds!
 
 To view the documentation, it's located [here](https://tenner-joshua.gitbook.io/as-pect/) on the gitbook. If there are any issues with the docs, please feel free to file an issue!
 
+## Reporter API
+
+This package writes JSON from the Suite report facts delivered to `onReportFinish({ report })`. Custom file reporters should prefer the report event callbacks from `@as-pect/core` and treat `onFinish(ctx)` as a legacy compatibility callback.
+
+## as-pect legacy JSON v1 contract
+
+`@as-pect/json-reporter` is the as-pect legacy JSON reporter. It is selected by `asp --json` and intentionally remains separate from the standardized CTRF reporter in `@as-pect/ctrf-reporter`.
+
+The reporter writes one sibling `.json` file per test entry. The file root is an array of result objects in execution order.
+
+Passing and failing tests use this field shape:
+
+```json
+{
+  "group": "math",
+  "name": "adds values",
+  "ran": true,
+  "pass": true,
+  "negated": false,
+  "runtime": 3,
+  "message": null,
+  "actual": "3",
+  "expected": "3"
+}
+```
+
+Failed tests keep the same fields with `pass: false`, assertion text in `message`, and reflected assertion strings in `actual` and `expected` when present.
+
+Todo results use the same object shape for compatibility:
+
+```json
+{
+  "group": "math",
+  "name": "TODO: handles division",
+  "ran": false,
+  "pass": null,
+  "negated": false,
+  "runtime": 0,
+  "message": "",
+  "actual": null,
+  "expected": null
+}
+```
+
+Use `asp --ctrf` or `asp --reporter @as-pect/ctrf-reporter` when a consumer expects CTRF root fields such as `reportFormat`, `specVersion`, and `results`.
+
 ## Contributors
 
 To contribute please see [CONTRIBUTING.md](./CONTRIBUTING.md).

package/tsconfig.json

@@ -1,49 +1,49 @@
 {
   "compilerOptions": {
     /* Basic Options */
-    "target": "ESNext",                          /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */
-    "module": "ESNext",                     /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
+    "target": "ESNext" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017','ES2018' or 'ESNEXT'. */,
+    "module": "ESNext" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
     // "lib": [],                             /* Specify library files to be included in the compilation. */
-    "allowJs": true,                          /* Allow javascript files to be compiled. */
-    "checkJs": true,                          /* Report errors in .js files. */
+    "allowJs": true /* Allow javascript files to be compiled. */,
+    "checkJs": true /* Report errors in .js files. */,
     // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
-    "declaration": true,                      /* Generates corresponding '.d.ts' file. */
-    "declarationMap": true,                   /* Generates a sourcemap for each corresponding '.d.ts' file. */
-    "sourceMap": true,                        /* Generates corresponding '.map' file. */
+    "declaration": true /* Generates corresponding '.d.ts' file. */,
+    "declarationMap": true /* Generates a sourcemap for each corresponding '.d.ts' file. */,
+    "sourceMap": true /* Generates corresponding '.map' file. */,
     // "outFile": "./",                       /* Concatenate and emit output to single file. */
-    "outDir": "./lib/",                       /* Redirect output structure to the directory. */
+    "outDir": "./lib/" /* Redirect output structure to the directory. */,
     // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
     // "composite": true,                     /* Enable project compilation */
     // "removeComments": true,                /* Do not emit comments to output. */
     // "noEmit": true,                        /* Do not emit outputs. */
     // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
-    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
     // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
 
     /* Strict Type-Checking Options */
-    "strict": true,                           /* Enable all strict type-checking options. */
-    "noImplicitAny": true,                    /* Raise error on expressions and declarations with an implied 'any' type. */
-    "strictNullChecks": true,                 /* Enable strict null checks. */
-    "strictFunctionTypes": true,              /* Enable strict checking of function types. */
-    "strictBindCallApply": true,              /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
-    "strictPropertyInitialization": true,     /* Enable strict checking of property initialization in classes. */
-    "noImplicitThis": true,                   /* Raise error on 'this' expressions with an implied 'any' type. */
-    "alwaysStrict": true,                     /* Parse in strict mode and emit "use strict" for each source file. */
+    "strict": true /* Enable all strict type-checking options. */,
+    "noImplicitAny": true /* Raise error on expressions and declarations with an implied 'any' type. */,
+    "strictNullChecks": true /* Enable strict null checks. */,
+    "strictFunctionTypes": true /* Enable strict checking of function types. */,
+    "strictBindCallApply": true /* Enable strict 'bind', 'call', and 'apply' methods on functions. */,
+    "strictPropertyInitialization": true /* Enable strict checking of property initialization in classes. */,
+    "noImplicitThis": true /* Raise error on 'this' expressions with an implied 'any' type. */,
+    "alwaysStrict": true /* Parse in strict mode and emit "use strict" for each source file. */,
 
     /* Additional Checks */
-    "noUnusedLocals": true,                   /* Report errors on unused locals. */
-    "noUnusedParameters": true,               /* Report errors on unused parameters. */
-    "noImplicitReturns": true,                /* Report error when not all code paths in function return a value. */
-    "noFallthroughCasesInSwitch": true,       /* Report errors for fallthrough cases in switch statement. */
+    "noUnusedLocals": true /* Report errors on unused locals. */,
+    "noUnusedParameters": true /* Report errors on unused parameters. */,
+    "noImplicitReturns": true /* Report error when not all code paths in function return a value. */,
+    "noFallthroughCasesInSwitch": true /* Report errors for fallthrough cases in switch statement. */,
 
     /* Module Resolution Options */
-    "moduleResolution": "node",               /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    "moduleResolution": "bundler" /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */,
     // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */                          /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
     // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
     // "typeRoots": [],                       /* List of folders to include type definitions from. */
-    // "types": [],                           /* Type declaration files to be included in compilation. */
+    "types": ["node"] /* Type declaration files to be included in compilation. */,
     // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
-    "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
     // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
 
     /* Source Map Options */
@@ -52,8 +52,12 @@
     // "inlineSourceMap": true                /* Emit a single file with source maps instead of having a separate file. */
     // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
 
+    "skipLibCheck": true
+
     /* Experimental Options */
     // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
     // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
   },
+  "include": ["index.ts"],
+  "exclude": ["__tests__", "lib", "node_modules"]
 }