@as-pect/csv-reporter 8.1.0 → 9.0.0

package/CHANGELOG.md

@@ -0,0 +1,16 @@
+# @as-pect/csv-reporter
+
+## 9.0.0
+
+### Patch Changes
+
+- 65058fe: Share file-backed reporter output behavior across CSV and JSON reporters while preserving existing output paths and formats.
+- 703fde8: Document the as-pect CSV v1 column contract and add compatibility coverage for CSV escaping and empty actual/expected fields.
+- 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__/CSVReporter.spec.ts

@@ -0,0 +1,240 @@
+import { access, mkdir, mkdtemp, readFile, rm } from "fs/promises";
+import { join, relative } from "path";
+import CSVReporter from "../index.js";
+import type { SuiteReport, SuiteResultReport } from "@as-pect/core";
+
+class TestCSVReporter extends CSVReporter {
+  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: "ok",
+    stackTrace: null,
+    rtraceDelta: 0,
+    logs: [],
+    actual: "3",
+    expected: "3",
+    actualValue: null,
+    expectedValue: null,
+    ...overrides,
+  } as SuiteResultReport;
+}
+
+function parseRows(output: string): string[][] {
+  const rows: string[][] = [];
+  let row: string[] = [];
+  let field = "";
+  let quoted = false;
+
+  for (let i = 0; i < output.length; i++) {
+    const char = output[i];
+    const next = output[i + 1];
+
+    if (quoted) {
+      if (char === '"' && next === '"') {
+        field += '"';
+        i++;
+      } else if (char === '"') {
+        quoted = false;
+      } else {
+        field += char;
+      }
+    } else if (char === '"') {
+      quoted = true;
+    } else if (char === ",") {
+      row.push(field);
+      field = "";
+    } else if (char === "\n") {
+      row.push(field);
+      rows.push(row);
+      row = [];
+      field = "";
+    } else if (char !== "\r") {
+      field += char;
+    }
+  }
+
+  if (field !== "" || row.length > 0) {
+    row.push(field);
+    rows.push(row);
+  }
+
+  return rows;
+}
+
+async function reporterCreatesFile(report: Pick<SuiteReport, "hasResults" | "results">): Promise<boolean> {
+  const tempDir = await mkdtemp(join(process.cwd(), "tmp-csv-reporter-"));
+  const fileName = join(relative(process.cwd(), tempDir), "example.spec.ts");
+  const reporter = new TestCSVReporter();
+  const outputPath = join(tempDir, "example.spec.csv");
+
+  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<string[][]> {
+  const tempDir = await mkdtemp(join(process.cwd(), "tmp-csv-reporter-"));
+  const fileName = join(relative(process.cwd(), tempDir), "example.spec.ts");
+  const reporter = new TestCSVReporter();
+
+  try {
+    await reporter.writeAndWait({ fileName, hasResults: true, results });
+    const output = await readFile(join(tempDir, "example.spec.csv"), "utf8");
+    return parseRows(output);
+  } finally {
+    await rm(tempDir, { recursive: true, force: true });
+  }
+}
+
+async function runNestedReporter(): Promise<string[][]> {
+  const tempDir = await mkdtemp(join(process.cwd(), "tmp-csv-reporter-"));
+  const sourceDir = join(tempDir, "assembly", "__tests__");
+  const fileName = join(relative(process.cwd(), sourceDir), "entry.spec.ts");
+  const reporter = new TestCSVReporter();
+
+  try {
+    await mkdir(sourceDir, { recursive: true });
+    await reporter.writeAndWait({ fileName, hasResults: true, results: [testResult()] });
+    const output = await readFile(join(sourceDir, "entry.spec.csv"), "utf8");
+    return parseRows(output);
+  } finally {
+    await rm(tempDir, { recursive: true, force: true });
+  }
+}
+
+async function runProjectRootReporter(): Promise<string[][]> {
+  const tempDir = await mkdtemp(join(process.cwd(), "tmp-csv-reporter-root-"));
+  const sourceDir = join(tempDir, "assembly", "__tests__");
+  const reporter = new TestCSVReporter(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.csv"), "utf8");
+    return parseRows(output);
+  } finally {
+    await rm(tempDir, { recursive: true, force: true });
+  }
+}
+
+async function writeReportWithMissingOutputDirectory(): Promise<void> {
+  const tempDir = await mkdtemp(join(process.cwd(), "tmp-csv-reporter-"));
+  const fileName = join(relative(process.cwd(), tempDir), "missing", "entry.spec.ts");
+  const reporter = new TestCSVReporter();
+
+  try {
+    await reporter.writeAndWait({ fileName, hasResults: true, results: [testResult()] });
+  } finally {
+    await rm(tempDir, { recursive: true, force: true });
+  }
+}
+
+describe("CSVReporter", () => {
+  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 the documented CSV header order", async () => {
+    await expect(runReporter([])).resolves.toEqual([
+      ["Group", "Name", "Ran", "Negated", "Pass", "Runtime", "Message", "Actual", "Expected"],
+    ]);
+  });
+
+  it("writes the CSV file next to a nested test entry", async () => {
+    await expect(runNestedReporter()).resolves.toEqual([
+      ["Group", "Name", "Ran", "Negated", "Pass", "Runtime", "Message", "Actual", "Expected"],
+      ["math", "adds values", "RAN", "FALSE", "PASS", "3", "ok", "3", "3"],
+    ]);
+  });
+
+  it("writes project-relative report files under the configured output root", async () => {
+    await expect(runProjectRootReporter()).resolves.toEqual([
+      ["Group", "Name", "Ran", "Negated", "Pass", "Runtime", "Message", "Actual", "Expected"],
+      ["math", "adds values", "RAN", "FALSE", "PASS", "3", "ok", "3", "3"],
+    ]);
+  });
+
+  it("surfaces output stream errors through flush", async () => {
+    await expect(writeReportWithMissingOutputDirectory()).rejects.toMatchObject({ code: "ENOENT" });
+  });
+
+  it("writes test rows in the same column order as the header", async () => {
+    await expect(runReporter([testResult()])).resolves.toEqual([
+      ["Group", "Name", "Ran", "Negated", "Pass", "Runtime", "Message", "Actual", "Expected"],
+      ["math", "adds values", "RAN", "FALSE", "PASS", "3", "ok", "3", "3"],
+    ]);
+  });
+
+  it("writes NOT RUN under the Ran column for skipped test rows", async () => {
+    await expect(runReporter([testResult({ name: "skips values", ran: false })])).resolves.toEqual([
+      ["Group", "Name", "Ran", "Negated", "Pass", "Runtime", "Message", "Actual", "Expected"],
+      ["math", "skips values", "NOT RUN", "FALSE", "PASS", "3", "ok", "3", "3"],
+    ]);
+  });
+
+  it("writes todo rows in the same column order as the header", async () => {
+    await expect(
+      runReporter([
+        {
+          type: "todo",
+          groupName: "math",
+          description: "handles division",
+        },
+      ]),
+    ).resolves.toEqual([
+      ["Group", "Name", "Ran", "Negated", "Pass", "Runtime", "Message", "Actual", "Expected"],
+      ["math", "handles division", "TODO", "", "", "", "", "", ""],
+    ]);
+  });
+
+  it("emits values with comma, quote, and newline as parseable CSV fields", async () => {
+    await expect(
+      runReporter([
+        testResult({
+          groupName: "math, core",
+          name: 'quotes "work"',
+          message: "line one\nline two",
+          actual: "1,2",
+          expected: '"1,2"',
+        }),
+      ]),
+    ).resolves.toEqual([
+      ["Group", "Name", "Ran", "Negated", "Pass", "Runtime", "Message", "Actual", "Expected"],
+      ["math, core", 'quotes "work"', "RAN", "FALSE", "PASS", "3", "line one\nline two", "1,2", '"1,2"'],
+    ]);
+  });
+
+  it("keeps null actual and expected values as empty CSV fields", async () => {
+    await expect(runReporter([testResult({ actual: null, expected: null })])).resolves.toEqual([
+      ["Group", "Name", "Ran", "Negated", "Pass", "Runtime", "Message", "Actual", "Expected"],
+      ["math", "adds values", "RAN", "FALSE", "PASS", "3", "ok", "", ""],
+    ]);
+  });
+});

package/index.ts

@@ -1,22 +1,12 @@
 import { Stringifier, stringify } from "csv-stringify";
-import { WriteStream, createWriteStream } from "fs";
-import { basename, extname, dirname, join } from "path";
-import { TestNodeType, TestContext, IReporter, TestNode, IWritable } from "@as-pect/core";
+import { finished } from "stream/promises";
+import { TestContext, IReporter, IWritable, SuiteReport, SuiteReportEvent, SuiteResultReport } from "@as-pect/core";
+import { ReporterFileOutput } from "@as-pect/reporter-output";
 
 /**
  * This is a list of all the columns in the exported csv file.
  */
-const csvColumns = [
-  "Group",
-  "Name",
-  "Ran",
-  "Negated",
-  "Pass",
-  "Runtime",
-  "Message",
-  "Actual",
-  "Expected",
-];
+const csvColumns = ["Group", "Name", "Ran", "Negated", "Pass", "Runtime", "Message", "Actual", "Expected"];
 
 /**
  * This class is responsible for creating a csv file located at {testName}.spec.csv. It will
@@ -27,55 +17,61 @@ export default class CSVReporter implements IReporter {
   public stderr: IWritable | null = null;
 
   protected output: Stringifier | null = null;
-  protected fileName: WriteStream | null = null;
+  protected fileOutput: ReporterFileOutput;
 
-  public onEnter(ctx: TestContext): void {
-    this.output = stringify({ columns: csvColumns });
-    const extension = extname(ctx.fileName);
-    const dir = dirname(ctx.fileName);
-    const base = basename(ctx.fileName, extension);
-    const outPath = join(process.cwd(), dir, base + ".csv");
-    this.fileName = createWriteStream(outPath, "utf8");
-    this.output.pipe(this.fileName);
-    this.output.write(csvColumns);
+  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 onFinish(): void {
-    this.output!.end();
+  public onExit(_ctx: TestContext): void {}
+
+  public onReportFinish(event: SuiteReportEvent): void {
+    this.writeReport(event.report);
   }
 
-  protected onGroupFinish(group: TestNode): void {
-    if (group.children.length === 0) return;
+  public onFinish(ctx: TestContext): void {
+    this.writeReport(SuiteReport.from(ctx));
+  }
 
-    group.groupTests.forEach((test) => this.onTestFinish(group, test));
-    group.groupTodos.forEach((desc) => this.onTodo(group, desc));
+  public onFlush(): Promise<void> {
+    return this.fileOutput.flush();
   }
 
-  protected onTestFinish(group: TestNode, test: TestNode) {
-    this.output!.write([
-      group.name,
-      test.ran ? "RAN" : "NOT RUN",
-      test.name,
-      test.negated ? "TRUE" : "FALSE",
-      test.pass ? "PASS" : "FAIL",
-      test.deltaT.toString(),
-      test.message,
-      test.actual ? test.actual.stringify({ indent: 0 }) : "",
-      test.expected
-        ? `${test.negated ? "Not " : ""}${test.expected.stringify({
-            indent: 0,
-          })}`
-        : "",
-    ]);
+  protected writeReport(report: SuiteReport): void {
+    if (report.hasResults === false) return;
+
+    const fileReport = this.fileOutput.start(report, ".csv");
+    if (fileReport === null) return;
+
+    this.output = stringify({ columns: csvColumns });
+    this.output.pipe(fileReport.stream);
+    this.fileOutput.trackFlush(finished(this.output).then(() => undefined));
+    this.output.write(csvColumns);
+
+    for (const result of report.results) {
+      this.onResult(result);
+    }
+
+    this.output.end();
   }
 
-  protected onTodo(group: TestNode, desc: string) {
-    this.output!.write([group.name, "TODO", desc, "", "", "", "", "", ""]);
+  protected onResult(result: SuiteResultReport): void {
+    if (result.type === "test") {
+      this.output!.write([
+        result.groupName,
+        result.name,
+        result.ran ? "RAN" : "NOT RUN",
+        result.negated ? "TRUE" : "FALSE",
+        result.pass ? "PASS" : "FAIL",
+        result.runtime.toString(),
+        result.message,
+        result.actual || "",
+        result.expected || "",
+      ]);
+    } else {
+      this.output!.write([result.groupName, result.description, "TODO", "", "", "", "", "", ""]);
+    }
   }
-};
+}

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,7 +1,6 @@
-/// <reference types="node" />
 import { Stringifier } from "csv-stringify";
-import { WriteStream } from "fs";
-import { TestContext, IReporter, TestNode, IWritable } from "@as-pect/core";
+import { TestContext, IReporter, IWritable, SuiteReport, SuiteReportEvent, SuiteResultReport } from "@as-pect/core";
+import { ReporterFileOutput } from "@as-pect/reporter-output";
 /**
  * This class is responsible for creating a csv file located at {testName}.spec.csv. It will
  * contain a set of tests with relevant pass and fail information.
@@ -10,12 +9,14 @@ export default class CSVReporter implements IReporter {
     stdout: IWritable | null;
     stderr: IWritable | null;
     protected output: Stringifier | null;
-    protected fileName: WriteStream | null;
-    onEnter(ctx: TestContext): void;
-    onExit(_ctx: TestContext, node: TestNode): void;
-    onFinish(): void;
-    protected onGroupFinish(group: TestNode): void;
-    protected onTestFinish(group: TestNode, test: TestNode): void;
-    protected onTodo(group: TestNode, desc: string): void;
+    protected fileOutput: ReporterFileOutput;
+    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;
 }
 //# 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,EAAa,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,WAAW,EAAqB,MAAM,IAAI,CAAC;AAEpD,OAAO,EAAgB,WAAW,EAAE,SAAS,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAiB1F;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,WAAY,YAAW,SAAS;IAC5C,MAAM,EAAE,SAAS,GAAG,IAAI,CAAQ;IAChC,MAAM,EAAE,SAAS,GAAG,IAAI,CAAQ;IAEvC,SAAS,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,CAAQ;IAC5C,SAAS,CAAC,QAAQ,EAAE,WAAW,GAAG,IAAI,CAAQ;IAEvC,OAAO,CAAC,GAAG,EAAE,WAAW,GAAG,IAAI;IAW/B,MAAM,CAAC,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,GAAG,IAAI;IAM/C,QAAQ,IAAI,IAAI;IAIvB,SAAS,CAAC,aAAa,CAAC,KAAK,EAAE,QAAQ,GAAG,IAAI;IAO9C,SAAS,CAAC,YAAY,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ;IAkBtD,SAAS,CAAC,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM;CAG/C"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAa,MAAM,eAAe,CAAC;AAEvD,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;AAO9D;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,WAAY,YAAW,SAAS;IAC5C,MAAM,EAAE,SAAS,GAAG,IAAI,CAAQ;IAChC,MAAM,EAAE,SAAS,GAAG,IAAI,CAAQ;IAEvC,SAAS,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,CAAQ;IAC5C,SAAS,CAAC,UAAU,EAAE,kBAAkB,CAAC;gBAEtB,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;IAkBhD,SAAS,CAAC,QAAQ,CAAC,MAAM,EAAE,iBAAiB,GAAG,IAAI;CAiBpD"}

package/lib/index.js

@@ -1,20 +1,11 @@
 import { stringify } from "csv-stringify";
-import { createWriteStream } from "fs";
-import { basename, extname, dirname, join } from "path";
+import { finished } from "stream/promises";
+import { SuiteReport } from "@as-pect/core";
+import { ReporterFileOutput } from "@as-pect/reporter-output";
 /**
  * This is a list of all the columns in the exported csv file.
  */
-const csvColumns = [
-    "Group",
-    "Name",
-    "Ran",
-    "Negated",
-    "Pass",
-    "Runtime",
-    "Message",
-    "Actual",
-    "Expected",
-];
+const csvColumns = ["Group", "Name", "Ran", "Negated", "Pass", "Runtime", "Message", "Actual", "Expected"];
 /**
  * This class is responsible for creating a csv file located at {testName}.spec.csv. It will
  * contain a set of tests with relevant pass and fail information.
@@ -23,51 +14,53 @@ export default class CSVReporter {
     stdout = null;
     stderr = null;
     output = null;
-    fileName = null;
-    onEnter(ctx) {
-        this.output = stringify({ columns: csvColumns });
-        const extension = extname(ctx.fileName);
-        const dir = dirname(ctx.fileName);
-        const base = basename(ctx.fileName, extension);
-        const outPath = join(process.cwd(), dir, base + ".csv");
-        this.fileName = createWriteStream(outPath, "utf8");
-        this.output.pipe(this.fileName);
-        this.output.write(csvColumns);
+    fileOutput;
+    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() {
-        this.output.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.output.write([
-            group.name,
-            test.ran ? "RAN" : "NOT RUN",
-            test.name,
-            test.negated ? "TRUE" : "FALSE",
-            test.pass ? "PASS" : "FAIL",
-            test.deltaT.toString(),
-            test.message,
-            test.actual ? test.actual.stringify({ indent: 0 }) : "",
-            test.expected
-                ? `${test.negated ? "Not " : ""}${test.expected.stringify({
-                    indent: 0,
-                })}`
-                : "",
-        ]);
+    writeReport(report) {
+        if (report.hasResults === false)
+            return;
+        const fileReport = this.fileOutput.start(report, ".csv");
+        if (fileReport === null)
+            return;
+        this.output = stringify({ columns: csvColumns });
+        this.output.pipe(fileReport.stream);
+        this.fileOutput.trackFlush(finished(this.output).then(() => undefined));
+        this.output.write(csvColumns);
+        for (const result of report.results) {
+            this.onResult(result);
+        }
+        this.output.end();
     }
-    onTodo(group, desc) {
-        this.output.write([group.name, "TODO", desc, "", "", "", "", "", ""]);
+    onResult(result) {
+        if (result.type === "test") {
+            this.output.write([
+                result.groupName,
+                result.name,
+                result.ran ? "RAN" : "NOT RUN",
+                result.negated ? "TRUE" : "FALSE",
+                result.pass ? "PASS" : "FAIL",
+                result.runtime.toString(),
+                result.message,
+                result.actual || "",
+                result.expected || "",
+            ]);
+        }
+        else {
+            this.output.write([result.groupName, result.description, "TODO", "", "", "", "", "", ""]);
+        }
     }
 }
-;
 //# 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,SAAS,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAe,iBAAiB,EAAE,MAAM,IAAI,CAAC;AACpD,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAGxD;;GAEG;AACH,MAAM,UAAU,GAAG;IACjB,OAAO;IACP,MAAM;IACN,KAAK;IACL,SAAS;IACT,MAAM;IACN,SAAS;IACT,SAAS;IACT,QAAQ;IACR,UAAU;CACX,CAAC;AAEF;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,WAAW;IACvB,MAAM,GAAqB,IAAI,CAAC;IAChC,MAAM,GAAqB,IAAI,CAAC;IAE7B,MAAM,GAAuB,IAAI,CAAC;IAClC,QAAQ,GAAuB,IAAI,CAAC;IAEvC,OAAO,CAAC,GAAgB;QAC7B,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;QACjD,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,MAAM,CAAC,CAAC;QACxD,IAAI,CAAC,QAAQ,GAAG,iBAAiB,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QACnD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAChC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAChC,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;QACb,IAAI,CAAC,MAAO,CAAC,GAAG,EAAE,CAAC;IACrB,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,MAAO,CAAC,KAAK,CAAC;YACjB,KAAK,CAAC,IAAI;YACV,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;YAC5B,IAAI,CAAC,IAAI;YACT,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO;YAC/B,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM;YAC3B,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE;YACtB,IAAI,CAAC,OAAO;YACZ,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE;YACvD,IAAI,CAAC,QAAQ;gBACX,CAAC,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC;oBACtD,MAAM,EAAE,CAAC;iBACV,CAAC,EAAE;gBACN,CAAC,CAAC,EAAE;SACP,CAAC,CAAC;IACL,CAAC;IAES,MAAM,CAAC,KAAe,EAAE,IAAY;QAC5C,IAAI,CAAC,MAAO,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;IACzE,CAAC;CACF;AAAA,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAe,SAAS,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,iBAAiB,CAAC;AAC3C,OAAO,EAAqC,WAAW,EAAuC,MAAM,eAAe,CAAC;AACpH,OAAO,EAAE,kBAAkB,EAAE,MAAM,0BAA0B,CAAC;AAE9D;;GAEG;AACH,MAAM,UAAU,GAAG,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,SAAS,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;AAE3G;;;GAGG;AACH,MAAM,CAAC,OAAO,OAAO,WAAW;IACvB,MAAM,GAAqB,IAAI,CAAC;IAChC,MAAM,GAAqB,IAAI,CAAC;IAE7B,MAAM,GAAuB,IAAI,CAAC;IAClC,UAAU,CAAqB;IAEzC,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,MAAM,CAAC,CAAC;QACzD,IAAI,UAAU,KAAK,IAAI;YAAE,OAAO;QAEhC,IAAI,CAAC,MAAM,GAAG,SAAS,CAAC,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;QACjD,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACpC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC;QACxE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;QAE9B,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;YACpC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;QACxB,CAAC;QAED,IAAI,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC;IACpB,CAAC;IAES,QAAQ,CAAC,MAAyB;QAC1C,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;YAC3B,IAAI,CAAC,MAAO,CAAC,KAAK,CAAC;gBACjB,MAAM,CAAC,SAAS;gBAChB,MAAM,CAAC,IAAI;gBACX,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS;gBAC9B,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO;gBACjC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM;gBAC7B,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE;gBACzB,MAAM,CAAC,OAAO;gBACd,MAAM,CAAC,MAAM,IAAI,EAAE;gBACnB,MAAM,CAAC,QAAQ,IAAI,EAAE;aACtB,CAAC,CAAC;QACL,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,MAAO,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,WAAW,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC;QAC7F,CAAC;IACH,CAAC;CACF"}

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@as-pect/csv-reporter",
-  "version": "8.1.0",
+  "version": "9.0.0",
   "description": "csv reporter for as-pect",
   "main": "lib/index.js",
   "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",
@@ -15,11 +15,12 @@
   },
   "author": "Joshua Tenner",
   "license": "MIT",
-  "devDependencies": {
-    "csv-stringify": "^6.2.3"
-  },
   "dependencies": {
-    "@as-pect/core": "^8.1.0"
+    "@as-pect/core": "^9.0.0",
+    "@as-pect/reporter-output": "^9.0.0",
+    "csv-stringify": "^6.7.0"
   },
-  "gitHead": "aa6aa77222efb41b3d9889ab190e452fa0f091c8"
+  "publishConfig": {
+    "access": "public"
+  }
 }

package/readme.md

@@ -1,9 +1,8 @@
 # jtenner/as-pect - @as-pect/csv-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,40 @@ 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 CSV rows 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 CSV v1 contract
+
+`@as-pect/csv-reporter` emits an as-pect-specific tabular export for spreadsheet and lightweight data-processing workflows. It is not a cross-tool test-result standard.
+
+The CSV file is written next to the test entry with the entry extension replaced by `.csv`. For example, `assembly/__tests__/entry.spec.ts` writes `assembly/__tests__/entry.spec.csv`. Empty reports where `SuiteReport.hasResults === false` do not create a file.
+
+The v1 column order is stable and compatibility-tested:
+
+| Column | Test result values | Todo result values |
+| --- | --- | --- |
+| `Group` | Suite result `groupName` | Todo `groupName` |
+| `Name` | Test name | Todo description |
+| `Ran` | `RAN` or `NOT RUN` | `TODO` |
+| `Negated` | `TRUE` or `FALSE` | Empty |
+| `Pass` | `PASS` or `FAIL` | Empty |
+| `Runtime` | Runtime in milliseconds | Empty |
+| `Message` | Result message | Empty |
+| `Actual` | Actual value text, or empty when null | Empty |
+| `Expected` | Expected value text, or empty when null | Empty |
+
+Example output:
+
+```csv
+Group,Name,Ran,Negated,Pass,Runtime,Message,Actual,Expected
+math,adds values,RAN,FALSE,PASS,3,ok,3,3
+math,handles division,TODO,,,,,,
+```
+
+Values are emitted through `csv-stringify`, so commas, quotes, and newlines are escaped as CSV fields instead of changing the column contract. Future column additions or vocabulary changes should use a new CSV contract version or an explicit migration note.
+
 ## Contributors
 
 To contribute please see [CONTRIBUTING.md](./CONTRIBUTING.md).

package/tsconfig.json

@@ -17,7 +17,7 @@
     // "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 */
@@ -37,12 +37,12 @@
     "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. */
     // "paths": {},                           /* 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'. */
     // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
@@ -53,8 +53,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"]
 }