From f4eb54c70a76dc9c831cf14f5e5c628022f8fac5 Mon Sep 17 00:00:00 2001 From: Erin Millard Date: Fri, 8 Nov 2024 08:50:26 +1000 Subject: [PATCH] Replace AUSTENITE_SPEC with AUSTENITE_MODE --- .prettierignore | 2 +- Makefile | 2 +- README.md | 12 ++++++------ src/initialize.ts | 10 ++++------ src/{specification.ts => usage.ts} | 0 test/fixture/{specification => usage}/app-env-var.md | 0 .../{specification => usage}/big-integer/default.md | 0 .../{specification => usage}/big-integer/examples.md | 0 .../{specification => usage}/big-integer/optional.md | 0 .../{specification => usage}/big-integer/required.md | 0 .../{specification => usage}/binary/default.md | 0 .../{specification => usage}/binary/examples.md | 0 .../{specification => usage}/binary/optional.md | 0 .../{specification => usage}/binary/required.md | 0 .../boolean/custom-literals.md | 0 .../{specification => usage}/boolean/default.md | 0 .../{specification => usage}/boolean/examples.md | 0 .../{specification => usage}/boolean/optional.md | 0 .../{specification => usage}/boolean/required.md | 0 test/fixture/{specification => usage}/constraints.md | 0 .../{specification => usage}/duration/default.md | 0 .../{specification => usage}/duration/examples.md | 0 .../{specification => usage}/duration/optional.md | 0 .../{specification => usage}/duration/required.md | 0 test/fixture/{specification => usage}/empty.md | 0 .../{specification => usage}/enumeration/default.md | 0 .../{specification => usage}/enumeration/examples.md | 0 .../{specification => usage}/enumeration/optional.md | 0 .../{specification => usage}/enumeration/required.md | 0 test/fixture/{specification => usage}/examples.md | 0 .../{specification => usage}/integer/default.md | 0 .../{specification => usage}/integer/examples.md | 0 .../{specification => usage}/integer/optional.md | 0 .../{specification => usage}/integer/required.md | 0 .../kubernetes-address/default.md | 0 .../kubernetes-address/examples.md | 0 .../kubernetes-address/named-ports.md | 0 .../kubernetes-address/optional.md | 0 .../kubernetes-address/required.md | 0 .../{specification => usage}/markdown-escaping.md | 0 .../network-port-number/default.md | 0 .../network-port-number/examples.md | 0 .../network-port-number/optional.md | 0 .../network-port-number/required.md | 0 .../no-prettier/prettier-disabled.md | 0 .../no-prettier/prettier-not-configured.md | 0 .../no-prettier/prettier-unavailable.md | 0 .../{specification => usage}/number/default.md | 0 .../{specification => usage}/number/examples.md | 0 .../{specification => usage}/number/optional.md | 0 .../{specification => usage}/number/required.md | 0 test/fixture/{specification => usage}/sensitive.md | 0 .../{specification => usage}/string/default.md | 0 .../{specification => usage}/string/examples.md | 0 .../{specification => usage}/string/optional.md | 0 .../{specification => usage}/string/quoting.md | 0 .../{specification => usage}/string/required.md | 0 test/fixture/{specification => usage}/url/base.md | 0 test/fixture/{specification => usage}/url/default.md | 0 .../fixture/{specification => usage}/url/examples.md | 0 .../fixture/{specification => usage}/url/optional.md | 0 .../{specification => usage}/url/protocols.md | 0 .../fixture/{specification => usage}/url/required.md | 0 ...ation-prettier.spec.ts => usage-prettier.spec.ts} | 6 +++--- test/suite/{specification.spec.ts => usage.spec.ts} | 6 +++--- 65 files changed, 18 insertions(+), 20 deletions(-) rename src/{specification.ts => usage.ts} (100%) rename test/fixture/{specification => usage}/app-env-var.md (100%) rename test/fixture/{specification => usage}/big-integer/default.md (100%) rename test/fixture/{specification => usage}/big-integer/examples.md (100%) rename test/fixture/{specification => usage}/big-integer/optional.md (100%) rename test/fixture/{specification => usage}/big-integer/required.md (100%) rename test/fixture/{specification => usage}/binary/default.md (100%) rename test/fixture/{specification => usage}/binary/examples.md (100%) rename test/fixture/{specification => usage}/binary/optional.md (100%) rename test/fixture/{specification => usage}/binary/required.md (100%) rename test/fixture/{specification => usage}/boolean/custom-literals.md (100%) rename test/fixture/{specification => usage}/boolean/default.md (100%) rename test/fixture/{specification => usage}/boolean/examples.md (100%) rename test/fixture/{specification => usage}/boolean/optional.md (100%) rename test/fixture/{specification => usage}/boolean/required.md (100%) rename test/fixture/{specification => usage}/constraints.md (100%) rename test/fixture/{specification => usage}/duration/default.md (100%) rename test/fixture/{specification => usage}/duration/examples.md (100%) rename test/fixture/{specification => usage}/duration/optional.md (100%) rename test/fixture/{specification => usage}/duration/required.md (100%) rename test/fixture/{specification => usage}/empty.md (100%) rename test/fixture/{specification => usage}/enumeration/default.md (100%) rename test/fixture/{specification => usage}/enumeration/examples.md (100%) rename test/fixture/{specification => usage}/enumeration/optional.md (100%) rename test/fixture/{specification => usage}/enumeration/required.md (100%) rename test/fixture/{specification => usage}/examples.md (100%) rename test/fixture/{specification => usage}/integer/default.md (100%) rename test/fixture/{specification => usage}/integer/examples.md (100%) rename test/fixture/{specification => usage}/integer/optional.md (100%) rename test/fixture/{specification => usage}/integer/required.md (100%) rename test/fixture/{specification => usage}/kubernetes-address/default.md (100%) rename test/fixture/{specification => usage}/kubernetes-address/examples.md (100%) rename test/fixture/{specification => usage}/kubernetes-address/named-ports.md (100%) rename test/fixture/{specification => usage}/kubernetes-address/optional.md (100%) rename test/fixture/{specification => usage}/kubernetes-address/required.md (100%) rename test/fixture/{specification => usage}/markdown-escaping.md (100%) rename test/fixture/{specification => usage}/network-port-number/default.md (100%) rename test/fixture/{specification => usage}/network-port-number/examples.md (100%) rename test/fixture/{specification => usage}/network-port-number/optional.md (100%) rename test/fixture/{specification => usage}/network-port-number/required.md (100%) rename test/fixture/{specification => usage}/no-prettier/prettier-disabled.md (100%) rename test/fixture/{specification => usage}/no-prettier/prettier-not-configured.md (100%) rename test/fixture/{specification => usage}/no-prettier/prettier-unavailable.md (100%) rename test/fixture/{specification => usage}/number/default.md (100%) rename test/fixture/{specification => usage}/number/examples.md (100%) rename test/fixture/{specification => usage}/number/optional.md (100%) rename test/fixture/{specification => usage}/number/required.md (100%) rename test/fixture/{specification => usage}/sensitive.md (100%) rename test/fixture/{specification => usage}/string/default.md (100%) rename test/fixture/{specification => usage}/string/examples.md (100%) rename test/fixture/{specification => usage}/string/optional.md (100%) rename test/fixture/{specification => usage}/string/quoting.md (100%) rename test/fixture/{specification => usage}/string/required.md (100%) rename test/fixture/{specification => usage}/url/base.md (100%) rename test/fixture/{specification => usage}/url/default.md (100%) rename test/fixture/{specification => usage}/url/examples.md (100%) rename test/fixture/{specification => usage}/url/optional.md (100%) rename test/fixture/{specification => usage}/url/protocols.md (100%) rename test/fixture/{specification => usage}/url/required.md (100%) rename test/suite/{specification-prettier.spec.ts => usage-prettier.spec.ts} (94%) rename test/suite/{specification.spec.ts => usage.spec.ts} (99%) diff --git a/.prettierignore b/.prettierignore index ed95976..afe194e 100644 --- a/.prettierignore +++ b/.prettierignore @@ -2,4 +2,4 @@ /.makefiles/ /artifacts/ /CHANGELOG.md -/test/fixture/specification/no-prettier/ +/test/fixture/usage/no-prettier/ diff --git a/Makefile b/Makefile index ade5e59..be08e5d 100644 --- a/Makefile +++ b/Makefile @@ -54,4 +54,4 @@ artifacts/dist/esm: tsconfig.build.esm.json tsconfig.json artifacts/link-depende @touch "$@" ENVIRONMENT.md: artifacts/link-dependencies.touch artifacts/dist $(JS_SOURCE_FILES) $(JS_TEST_FILES) - AUSTENITE_SPEC=true AUSTENITE_APP=example node test/fixture/example/run.js > "$@" + AUSTENITE_MODE=usage/markdown AUSTENITE_APP=example node test/fixture/example/run.js > "$@" diff --git a/README.md b/README.md index fa2aa25..be9ccf8 100644 --- a/README.md +++ b/README.md @@ -71,11 +71,11 @@ Environment Variables: ❯ WEIGHT weighting for this node ✗ set to 0, must be >= 1 ``` -## Generated environment specifications +## Generated usage documentation -If the environment variable `AUSTENITE_SPEC` is set to `true`, calling +If the environment variable `AUSTENITE_MODE` is set to `usage/markdown`, calling `initialize()` will terminate the process with a zero exit code, and output a -Markdown document containing a specification of the environment variables +Markdown document containing usage documentation for the environment variables consumed by each declaration. @@ -86,14 +86,14 @@ consumed by each declaration. > [!TIP] > If you have the [`prettier` NPM package] installed, Austenite will -> pretty-print specification output according to your Prettier config for a file -> at `./ENVIRONMENT.md`. +> pretty-print Markdown output according to your Prettier config for a file at +> `./ENVIRONMENT.md`. > > If you have Prettier installed, but don't have a config file for > `./ENVIRONMENT.md`, Austenite will use its own default Prettier config. > > If you don't have Prettier installed, or if you set the `markdownPrettyPrint` -> option to `"none"`, Austenite won't pretty-print specification output. +> option to `"none"`, Austenite won't pretty-print Markdown output. [`prettier` npm package]: https://npmjs.com/package/prettier diff --git a/src/initialize.ts b/src/initialize.ts index f7ac924..bb14c91 100644 --- a/src/initialize.ts +++ b/src/initialize.ts @@ -1,19 +1,17 @@ import { EOL } from "node:os"; import { state, variablesByName } from "./environment.js"; -import type { MarkdownPrettyPrintType } from "./specification.js"; import { render as renderSummary } from "./summary.js"; +import type { MarkdownPrettyPrintType } from "./usage.js"; import { validate, type Results } from "./validation.js"; export async function initialize( options: InitializeOptions = {}, ): Promise { - if (process.env.AUSTENITE_SPEC === "true") { + if (process.env.AUSTENITE_MODE === "usage/markdown") { const { markdownPrettyPrint = "prettier" } = options; - const { render: renderSpecification } = await import("./specification.js"); + const { render: renderUsage } = await import("./usage.js"); - console.log( - await renderSpecification(markdownPrettyPrint, variablesByName()), - ); + console.log(await renderUsage(markdownPrettyPrint, variablesByName())); // eslint-disable-next-line n/no-process-exit process.exit(0); diff --git a/src/specification.ts b/src/usage.ts similarity index 100% rename from src/specification.ts rename to src/usage.ts diff --git a/test/fixture/specification/app-env-var.md b/test/fixture/usage/app-env-var.md similarity index 100% rename from test/fixture/specification/app-env-var.md rename to test/fixture/usage/app-env-var.md diff --git a/test/fixture/specification/big-integer/default.md b/test/fixture/usage/big-integer/default.md similarity index 100% rename from test/fixture/specification/big-integer/default.md rename to test/fixture/usage/big-integer/default.md diff --git a/test/fixture/specification/big-integer/examples.md b/test/fixture/usage/big-integer/examples.md similarity index 100% rename from test/fixture/specification/big-integer/examples.md rename to test/fixture/usage/big-integer/examples.md diff --git a/test/fixture/specification/big-integer/optional.md b/test/fixture/usage/big-integer/optional.md similarity index 100% rename from test/fixture/specification/big-integer/optional.md rename to test/fixture/usage/big-integer/optional.md diff --git a/test/fixture/specification/big-integer/required.md b/test/fixture/usage/big-integer/required.md similarity index 100% rename from test/fixture/specification/big-integer/required.md rename to test/fixture/usage/big-integer/required.md diff --git a/test/fixture/specification/binary/default.md b/test/fixture/usage/binary/default.md similarity index 100% rename from test/fixture/specification/binary/default.md rename to test/fixture/usage/binary/default.md diff --git a/test/fixture/specification/binary/examples.md b/test/fixture/usage/binary/examples.md similarity index 100% rename from test/fixture/specification/binary/examples.md rename to test/fixture/usage/binary/examples.md diff --git a/test/fixture/specification/binary/optional.md b/test/fixture/usage/binary/optional.md similarity index 100% rename from test/fixture/specification/binary/optional.md rename to test/fixture/usage/binary/optional.md diff --git a/test/fixture/specification/binary/required.md b/test/fixture/usage/binary/required.md similarity index 100% rename from test/fixture/specification/binary/required.md rename to test/fixture/usage/binary/required.md diff --git a/test/fixture/specification/boolean/custom-literals.md b/test/fixture/usage/boolean/custom-literals.md similarity index 100% rename from test/fixture/specification/boolean/custom-literals.md rename to test/fixture/usage/boolean/custom-literals.md diff --git a/test/fixture/specification/boolean/default.md b/test/fixture/usage/boolean/default.md similarity index 100% rename from test/fixture/specification/boolean/default.md rename to test/fixture/usage/boolean/default.md diff --git a/test/fixture/specification/boolean/examples.md b/test/fixture/usage/boolean/examples.md similarity index 100% rename from test/fixture/specification/boolean/examples.md rename to test/fixture/usage/boolean/examples.md diff --git a/test/fixture/specification/boolean/optional.md b/test/fixture/usage/boolean/optional.md similarity index 100% rename from test/fixture/specification/boolean/optional.md rename to test/fixture/usage/boolean/optional.md diff --git a/test/fixture/specification/boolean/required.md b/test/fixture/usage/boolean/required.md similarity index 100% rename from test/fixture/specification/boolean/required.md rename to test/fixture/usage/boolean/required.md diff --git a/test/fixture/specification/constraints.md b/test/fixture/usage/constraints.md similarity index 100% rename from test/fixture/specification/constraints.md rename to test/fixture/usage/constraints.md diff --git a/test/fixture/specification/duration/default.md b/test/fixture/usage/duration/default.md similarity index 100% rename from test/fixture/specification/duration/default.md rename to test/fixture/usage/duration/default.md diff --git a/test/fixture/specification/duration/examples.md b/test/fixture/usage/duration/examples.md similarity index 100% rename from test/fixture/specification/duration/examples.md rename to test/fixture/usage/duration/examples.md diff --git a/test/fixture/specification/duration/optional.md b/test/fixture/usage/duration/optional.md similarity index 100% rename from test/fixture/specification/duration/optional.md rename to test/fixture/usage/duration/optional.md diff --git a/test/fixture/specification/duration/required.md b/test/fixture/usage/duration/required.md similarity index 100% rename from test/fixture/specification/duration/required.md rename to test/fixture/usage/duration/required.md diff --git a/test/fixture/specification/empty.md b/test/fixture/usage/empty.md similarity index 100% rename from test/fixture/specification/empty.md rename to test/fixture/usage/empty.md diff --git a/test/fixture/specification/enumeration/default.md b/test/fixture/usage/enumeration/default.md similarity index 100% rename from test/fixture/specification/enumeration/default.md rename to test/fixture/usage/enumeration/default.md diff --git a/test/fixture/specification/enumeration/examples.md b/test/fixture/usage/enumeration/examples.md similarity index 100% rename from test/fixture/specification/enumeration/examples.md rename to test/fixture/usage/enumeration/examples.md diff --git a/test/fixture/specification/enumeration/optional.md b/test/fixture/usage/enumeration/optional.md similarity index 100% rename from test/fixture/specification/enumeration/optional.md rename to test/fixture/usage/enumeration/optional.md diff --git a/test/fixture/specification/enumeration/required.md b/test/fixture/usage/enumeration/required.md similarity index 100% rename from test/fixture/specification/enumeration/required.md rename to test/fixture/usage/enumeration/required.md diff --git a/test/fixture/specification/examples.md b/test/fixture/usage/examples.md similarity index 100% rename from test/fixture/specification/examples.md rename to test/fixture/usage/examples.md diff --git a/test/fixture/specification/integer/default.md b/test/fixture/usage/integer/default.md similarity index 100% rename from test/fixture/specification/integer/default.md rename to test/fixture/usage/integer/default.md diff --git a/test/fixture/specification/integer/examples.md b/test/fixture/usage/integer/examples.md similarity index 100% rename from test/fixture/specification/integer/examples.md rename to test/fixture/usage/integer/examples.md diff --git a/test/fixture/specification/integer/optional.md b/test/fixture/usage/integer/optional.md similarity index 100% rename from test/fixture/specification/integer/optional.md rename to test/fixture/usage/integer/optional.md diff --git a/test/fixture/specification/integer/required.md b/test/fixture/usage/integer/required.md similarity index 100% rename from test/fixture/specification/integer/required.md rename to test/fixture/usage/integer/required.md diff --git a/test/fixture/specification/kubernetes-address/default.md b/test/fixture/usage/kubernetes-address/default.md similarity index 100% rename from test/fixture/specification/kubernetes-address/default.md rename to test/fixture/usage/kubernetes-address/default.md diff --git a/test/fixture/specification/kubernetes-address/examples.md b/test/fixture/usage/kubernetes-address/examples.md similarity index 100% rename from test/fixture/specification/kubernetes-address/examples.md rename to test/fixture/usage/kubernetes-address/examples.md diff --git a/test/fixture/specification/kubernetes-address/named-ports.md b/test/fixture/usage/kubernetes-address/named-ports.md similarity index 100% rename from test/fixture/specification/kubernetes-address/named-ports.md rename to test/fixture/usage/kubernetes-address/named-ports.md diff --git a/test/fixture/specification/kubernetes-address/optional.md b/test/fixture/usage/kubernetes-address/optional.md similarity index 100% rename from test/fixture/specification/kubernetes-address/optional.md rename to test/fixture/usage/kubernetes-address/optional.md diff --git a/test/fixture/specification/kubernetes-address/required.md b/test/fixture/usage/kubernetes-address/required.md similarity index 100% rename from test/fixture/specification/kubernetes-address/required.md rename to test/fixture/usage/kubernetes-address/required.md diff --git a/test/fixture/specification/markdown-escaping.md b/test/fixture/usage/markdown-escaping.md similarity index 100% rename from test/fixture/specification/markdown-escaping.md rename to test/fixture/usage/markdown-escaping.md diff --git a/test/fixture/specification/network-port-number/default.md b/test/fixture/usage/network-port-number/default.md similarity index 100% rename from test/fixture/specification/network-port-number/default.md rename to test/fixture/usage/network-port-number/default.md diff --git a/test/fixture/specification/network-port-number/examples.md b/test/fixture/usage/network-port-number/examples.md similarity index 100% rename from test/fixture/specification/network-port-number/examples.md rename to test/fixture/usage/network-port-number/examples.md diff --git a/test/fixture/specification/network-port-number/optional.md b/test/fixture/usage/network-port-number/optional.md similarity index 100% rename from test/fixture/specification/network-port-number/optional.md rename to test/fixture/usage/network-port-number/optional.md diff --git a/test/fixture/specification/network-port-number/required.md b/test/fixture/usage/network-port-number/required.md similarity index 100% rename from test/fixture/specification/network-port-number/required.md rename to test/fixture/usage/network-port-number/required.md diff --git a/test/fixture/specification/no-prettier/prettier-disabled.md b/test/fixture/usage/no-prettier/prettier-disabled.md similarity index 100% rename from test/fixture/specification/no-prettier/prettier-disabled.md rename to test/fixture/usage/no-prettier/prettier-disabled.md diff --git a/test/fixture/specification/no-prettier/prettier-not-configured.md b/test/fixture/usage/no-prettier/prettier-not-configured.md similarity index 100% rename from test/fixture/specification/no-prettier/prettier-not-configured.md rename to test/fixture/usage/no-prettier/prettier-not-configured.md diff --git a/test/fixture/specification/no-prettier/prettier-unavailable.md b/test/fixture/usage/no-prettier/prettier-unavailable.md similarity index 100% rename from test/fixture/specification/no-prettier/prettier-unavailable.md rename to test/fixture/usage/no-prettier/prettier-unavailable.md diff --git a/test/fixture/specification/number/default.md b/test/fixture/usage/number/default.md similarity index 100% rename from test/fixture/specification/number/default.md rename to test/fixture/usage/number/default.md diff --git a/test/fixture/specification/number/examples.md b/test/fixture/usage/number/examples.md similarity index 100% rename from test/fixture/specification/number/examples.md rename to test/fixture/usage/number/examples.md diff --git a/test/fixture/specification/number/optional.md b/test/fixture/usage/number/optional.md similarity index 100% rename from test/fixture/specification/number/optional.md rename to test/fixture/usage/number/optional.md diff --git a/test/fixture/specification/number/required.md b/test/fixture/usage/number/required.md similarity index 100% rename from test/fixture/specification/number/required.md rename to test/fixture/usage/number/required.md diff --git a/test/fixture/specification/sensitive.md b/test/fixture/usage/sensitive.md similarity index 100% rename from test/fixture/specification/sensitive.md rename to test/fixture/usage/sensitive.md diff --git a/test/fixture/specification/string/default.md b/test/fixture/usage/string/default.md similarity index 100% rename from test/fixture/specification/string/default.md rename to test/fixture/usage/string/default.md diff --git a/test/fixture/specification/string/examples.md b/test/fixture/usage/string/examples.md similarity index 100% rename from test/fixture/specification/string/examples.md rename to test/fixture/usage/string/examples.md diff --git a/test/fixture/specification/string/optional.md b/test/fixture/usage/string/optional.md similarity index 100% rename from test/fixture/specification/string/optional.md rename to test/fixture/usage/string/optional.md diff --git a/test/fixture/specification/string/quoting.md b/test/fixture/usage/string/quoting.md similarity index 100% rename from test/fixture/specification/string/quoting.md rename to test/fixture/usage/string/quoting.md diff --git a/test/fixture/specification/string/required.md b/test/fixture/usage/string/required.md similarity index 100% rename from test/fixture/specification/string/required.md rename to test/fixture/usage/string/required.md diff --git a/test/fixture/specification/url/base.md b/test/fixture/usage/url/base.md similarity index 100% rename from test/fixture/specification/url/base.md rename to test/fixture/usage/url/base.md diff --git a/test/fixture/specification/url/default.md b/test/fixture/usage/url/default.md similarity index 100% rename from test/fixture/specification/url/default.md rename to test/fixture/usage/url/default.md diff --git a/test/fixture/specification/url/examples.md b/test/fixture/usage/url/examples.md similarity index 100% rename from test/fixture/specification/url/examples.md rename to test/fixture/usage/url/examples.md diff --git a/test/fixture/specification/url/optional.md b/test/fixture/usage/url/optional.md similarity index 100% rename from test/fixture/specification/url/optional.md rename to test/fixture/usage/url/optional.md diff --git a/test/fixture/specification/url/protocols.md b/test/fixture/usage/url/protocols.md similarity index 100% rename from test/fixture/specification/url/protocols.md rename to test/fixture/usage/url/protocols.md diff --git a/test/fixture/specification/url/required.md b/test/fixture/usage/url/required.md similarity index 100% rename from test/fixture/specification/url/required.md rename to test/fixture/usage/url/required.md diff --git a/test/suite/specification-prettier.spec.ts b/test/suite/usage-prettier.spec.ts similarity index 94% rename from test/suite/specification-prettier.spec.ts rename to test/suite/usage-prettier.spec.ts index 1343134..6dc8138 100644 --- a/test/suite/specification-prettier.spec.ts +++ b/test/suite/usage-prettier.spec.ts @@ -14,10 +14,10 @@ import { import { MockConsole, createMockConsole } from "../helpers.js"; const fixturesPath = fileURLToPath( - new URL("../fixture/specification", import.meta.url), + new URL("../fixture/usage", import.meta.url), ); -describe("Specification documents (Prettier unavailable)", () => { +describe("Usage documentation (Prettier unavailable)", () => { let exitCode: number | undefined; let mockConsole: MockConsole; @@ -30,7 +30,7 @@ describe("Specification documents (Prettier unavailable)", () => { }); process.env = { - AUSTENITE_SPEC: "true", + AUSTENITE_MODE: "usage/markdown", }; mockConsole = createMockConsole(); diff --git a/test/suite/specification.spec.ts b/test/suite/usage.spec.ts similarity index 99% rename from test/suite/specification.spec.ts rename to test/suite/usage.spec.ts index 84adb43..7c0a2ee 100644 --- a/test/suite/specification.spec.ts +++ b/test/suite/usage.spec.ts @@ -19,12 +19,12 @@ import { beforeEach, describe, expect, it, vi } from "vitest"; import { MockConsole, createMockConsole } from "../helpers.js"; const fixturesPath = fileURLToPath( - new URL("../fixture/specification", import.meta.url), + new URL("../fixture/usage", import.meta.url), ); const { Duration } = Temporal; -describe("Specification documents", () => { +describe("Usage documentation", () => { let exitCode: number | undefined; let mockConsole: MockConsole; @@ -37,7 +37,7 @@ describe("Specification documents", () => { }); process.env = { - AUSTENITE_SPEC: "true", + AUSTENITE_MODE: "usage/markdown", }; mockConsole = createMockConsole();