Fix Redocly config load error (#1645)

* Fix Redocly config load error

* Update CHANGELOG

* Actually nevermind JSON5 isn’t a normal thing in OpenAPI

* Ensure lint error test fails if it didn’t lint

* Curse you, Windows GitHub Actions runner

* Aggregate output

* Update GH action syntax

* Fix Windows?

Author: drwpow

.github/workflows/ci.yml

@@ -27,7 +27,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [18.x, 20.x, 21.x]
+        node-version: [18, 20, 21]
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
@@ -52,8 +52,6 @@ jobs:
       - run: pnpm i
       - run: pnpm run build
       - run: pnpm test
-        env:
-          CI_ENV: macos
   test-windows:
     runs-on: windows-latest
     steps:
@@ -67,5 +65,3 @@ jobs:
       - run: pnpm i
       - run: pnpm run build
       - run: pnpm test
-        env:
-          CI_ENV: windows

package.json

@@ -8,10 +8,10 @@
     "email": "drew@pow.rs"
   },
   "scripts": {
-    "build": "pnpm run -r --parallel --filter \"!*docs\" build",
-    "lint": "pnpm run -r --parallel lint",
-    "format": "pnpm run -r --parallel format",
-    "test": "pnpm run -r --parallel test",
+    "build": "pnpm run -r --parallel --filter \"!*docs\" --aggregate-output build",
+    "lint": "pnpm run -r --parallel --aggregate-output lint",
+    "format": "pnpm run -r --parallel --aggregate-output format",
+    "test": "pnpm run -r --parallel --aggregate-output test",
     "version": "pnpm run build && changeset version && pnpm i"
   },
   "devDependencies": {

packages/openapi-fetch/package.json

@@ -48,13 +48,13 @@
   ],
   "scripts": {
     "build": "pnpm run build:clean && pnpm run build:js && pnpm run build:js-min && pnpm run build:cjs",
-    "build:clean": "del dist",
+    "build:clean": "del-cli dist",
     "build:js": "mkdir -p dist && cp src/* dist",
     "build:js-min": "esbuild --bundle src/index.js --format=esm --minify --outfile=dist/index.min.js && cp dist/index.d.ts dist/index.min.d.ts",
     "build:cjs": "esbuild --bundle src/index.js --format=cjs --outfile=dist/cjs/index.cjs && cp dist/index.d.ts dist/cjs/index.d.cts",
     "format": "biome format . --write",
     "lint": "biome check .",
-    "generate-types": "cd ../openapi-typescript && pnpm run build && cd ../openapi-fetch && ../openapi-typescript/bin/cli.js ./test/fixtures/api.yaml -o ./test/fixtures/v7-beta.d.ts && npx openapi-typescript ./test/fixtures/api.yaml -o ./test/fixtures/api.d.ts",
+    "generate-types": "node ./scripts/generate-types.js",
     "pretest": "pnpm run generate-types",
     "test": "pnpm run \"/^test:/\"",
     "test:js": "vitest run",
@@ -68,6 +68,7 @@
     "axios": "^1.6.8",
     "del-cli": "^5.1.0",
     "esbuild": "^0.20.2",
+    "execa": "^8.0.1",
     "msw": "^2.2.14",
     "openapi-typescript": "^6.7.5",
     "openapi-typescript-codegen": "^0.25.0",

packages/openapi-fetch/scripts/generate-types.js

@@ -0,0 +1,21 @@
+import { execa } from "execa";
+import { fileURLToPath } from "node:url";
+
+const root = new URL("../", import.meta.url);
+
+const SCHEMA = "./test/fixtures/api.yaml";
+const V6_OUTPUT = "./test/fixtures/api.d.ts";
+const V7_OUTPUT = "./test/fixtures/v7-beta.d.ts";
+
+async function generate() {
+  const cwd = fileURLToPath(root);
+
+  await Promise.all([
+    // note: the version inside node_modules is 6.x
+    execa("pnpm", ["exec", "openapi-typescript", SCHEMA, "-o", V6_OUTPUT], { cwd }),
+    // note: the version locally is 7.x
+    execa("../openapi-typescript/bin/cli.js", [SCHEMA, "-o", V7_OUTPUT], { cwd }),
+  ]);
+}
+
+generate();

packages/openapi-typescript/bin/cli.js

@@ -12,7 +12,7 @@ const HELP = `Usage
 Options
   --help                     Display this
   --version                  Display the version
-  --redoc [path], -c         Specify path to Redocly config (default: redocly.yaml)
+  --redocly [path], -c       Specify path to Redocly config (default: redocly.yaml)
   --output, -o               Specify output file (if not specified in redocly.yaml)
   --enum                     Export true TS enums instead of unions
   --export-type, -t          Export top-level \`type\` instead of \`interface\`
@@ -48,6 +48,9 @@ if (args.includes("--support-array-length")) {
 if (args.includes("-it")) {
   errorAndExit(`The -it alias has been deprecated. Use "--immutable-types" instead.`);
 }
+if (args.includes("--redoc")) {
+  errorAndExit(`The --redoc config flag has been renamed to "--redocly" (or -c as shorthand).`);
+}
 
 const flags = parser(args, {
   boolean: [
@@ -65,19 +68,19 @@ const flags = parser(args, {
     "immutable",
     "pathParamsAsTypes",
   ],
-  string: ["output", "redoc"],
+  string: ["output", "redocly"],
   alias: {
-    redoc: ["c"],
+    redocly: ["c"],
     exportType: ["t"],
     output: ["o"],
   },
 });
 
 /**
  * @param {string | URL} schema
- * @param {@type import('@redocly/openapi-core').Config} redoc
+ * @param {@type import('@redocly/openapi-core').Config} redocly
  */
-async function generateSchema(schema, { redoc, silent = false }) {
+async function generateSchema(schema, { redocly, silent = false }) {
   return `${COMMENT_HEADER}${astToString(
     await openapiTS(schema, {
       additionalProperties: flags.additionalProperties,
@@ -92,7 +95,7 @@ async function generateSchema(schema, { redoc, silent = false }) {
       exportType: flags.exportType,
       immutable: flags.immutable,
       pathParamsAsTypes: flags.pathParamsAsTypes,
-      redoc,
+      redocly,
       silent,
     }),
   )}`;
@@ -129,39 +132,32 @@ async function main() {
   const input = flags._[0];
 
   // load Redocly config
-  const maybeRedoc = findConfig(flags.redoc ? path.dirname(flags.redoc) : undefined);
-  const redoc = maybeRedoc
+  const maybeRedoc = findConfig(flags.redocly ? path.dirname(flags.redocly) : undefined);
+  const redocly = maybeRedoc
     ? await loadConfig({ configPath: maybeRedoc })
     : await createConfig({}, { extends: ["minimal"] });
 
   // handle Redoc APIs
-  const hasRedoclyApis = Object.keys(redoc?.apis ?? {}).length > 0;
+  const hasRedoclyApis = Object.keys(redocly?.apis ?? {}).length > 0;
   if (hasRedoclyApis) {
     if (input) {
       warn("APIs are specified both in Redocly Config and CLI argument. Only using Redocly config.");
     }
     await Promise.all(
-      Object.entries(redoc.apis).map(async ([name, api]) => {
+      Object.entries(redocly.apis).map(async ([name, api]) => {
         let configRoot = CWD;
-        if (redoc.configFile) {
+        if (redocly.configFile) {
           // note: this will be absolute if --redoc is passed; otherwise, relative
-          configRoot = path.isAbsolute(redoc.configFile)
-            ? new URL(`file://${redoc.configFile}`)
-            : new URL(redoc.configFile, `file://${process.cwd()}/`);
+          configRoot = path.isAbsolute(redocly.configFile)
+            ? new URL(`file://${redocly.configFile}`)
+            : new URL(redocly.configFile, `file://${process.cwd()}/`);
         }
         if (!api[REDOC_CONFIG_KEY]?.output) {
-          // TODO: remove in stable v7
-          if (api["openapi-ts"]) {
-            errorAndExit(`Please rename "openapi-ts" to "x-openapi-ts" in your Redoc config.`);
-          }
-
           errorAndExit(
             `API ${name} is missing an \`${REDOC_CONFIG_KEY}.output\` key. See https://openapi-ts.pages.dev/cli/#multiple-schemas.`,
           );
         }
-        const result = await generateSchema(new URL(api.root, configRoot), {
-          redoc, // TODO: merge API overrides better?
-        });
+        const result = await generateSchema(new URL(api.root, configRoot), { redocly });
         const outFile = new URL(api[REDOC_CONFIG_KEY].output, configRoot);
         fs.mkdirSync(new URL(".", outFile), { recursive: true });
         fs.writeFileSync(outFile, result, "utf8");
@@ -173,7 +169,7 @@ async function main() {
   // handle stdin
   else if (!input) {
     const result = await generateSchema(process.stdin, {
-      redoc,
+      redocly,
       silent: outputType === OUTPUT_STDOUT,
     });
     if (outputType === OUTPUT_STDOUT) {
@@ -196,7 +192,7 @@ async function main() {
       );
     }
     const result = await generateSchema(new URL(input, CWD), {
-      redoc,
+      redocly,
       silent: outputType === OUTPUT_STDOUT,
     });
     if (outputType === OUTPUT_STDOUT) {

packages/openapi-typescript/package.json

@@ -41,7 +41,7 @@
   },
   "scripts": {
     "build": "pnpm run build:clean && pnpm run build:esm && pnpm run build:cjs",
-    "build:clean": "del dist",
+    "build:clean": "del-cli dist",
     "build:esm": "tsc -p tsconfig.build.json",
     "build:cjs": "esbuild --bundle --platform=node --target=es2019 --outfile=dist/index.cjs --external:@redocly/ajv --external:@redocly/openapi-core --external:typescript src/index.ts",
     "dev": "tsc -p tsconfig.build.json --watch",
@@ -62,6 +62,7 @@
   "dependencies": {
     "@redocly/openapi-core": "^1.12.0",
     "ansi-colors": "^4.1.3",
+    "parse-json": "^8.1.0",
     "supports-color": "^9.4.0",
     "yargs-parser": "^21.1.1"
   },
@@ -72,7 +73,8 @@
     "degit": "^2.8.4",
     "del-cli": "^5.1.0",
     "esbuild": "^0.20.2",
-    "execa": "^7.2.0",
+    "execa": "^8.0.1",
+    "strip-ansi": "^7.1.0",
     "typescript": "^5.4.5",
     "vite-node": "^1.5.2",
     "vitest": "^1.5.2"

packages/openapi-typescript/src/lib/redoc.ts

@@ -9,6 +9,7 @@ import {
 } from "@redocly/openapi-core";
 import { Readable } from "node:stream";
 import { fileURLToPath } from "node:url";
+import parseJson from "parse-json";
 import type { OpenAPI3 } from "../types.js";
 import { debug, error, warn } from "./utils.js";
 
@@ -64,7 +65,7 @@ export async function parseSchema(schema: unknown, { absoluteRef, resolver }: Pa
     if (schema[0] === "{") {
       return {
         source: new Source(absoluteRef, schema, "application/json"),
-        parsed: JSON.parse(schema),
+        parsed: parseJson(schema),
       };
     }
     // YAML

packages/openapi-typescript/test/cli.test.ts

@@ -2,12 +2,13 @@ import { execa } from "execa";
 import fs from "node:fs";
 import os from "node:os";
 import { fileURLToPath } from "node:url";
+import stripAnsi from "strip-ansi";
 import type { TestCase } from "./test-helpers.js";
 
 const root = new URL("../", import.meta.url);
 const cwd = os.platform() === "win32" ? fileURLToPath(root) : root; // execa bug: fileURLToPath required on Windows
 const cmd = "./bin/cli.js";
-const TIMEOUT = 90000;
+const TIMEOUT = 90_000;
 
 describe("CLI", () => {
   const tests: TestCase<any, any>[] = [
@@ -107,22 +108,21 @@ describe("CLI", () => {
   });
 
   describe("Redocly config", () => {
-    // TODO: why won’t this run on Windows?
     test.skipIf(os.platform() === "win32")("automatic config", async () => {
-      // note: we have to change the cwd here for the automatic config to pick up properly
-      const root = new URL("./fixtures/redocly/", import.meta.url);
-      const cwd = os.platform() === "win32" ? fileURLToPath(root) : root;
+      const cwd = new URL("./fixtures/redocly/", import.meta.url);
 
-      await execa("../../../bin/cli.js", { cwd });
+      await execa("../../../bin/cli.js", {
+        cwd: fileURLToPath(cwd),
+      });
       for (const schema of ["a", "b", "c"]) {
-        expect(fs.readFileSync(new URL(`./output/${schema}.ts`, root), "utf8")).toMatchFileSnapshot(
-          fileURLToPath(new URL("../../../examples/simple-example.ts", root)),
+        expect(fs.readFileSync(new URL(`./output/${schema}.ts`, cwd), "utf8")).toMatchFileSnapshot(
+          fileURLToPath(new URL("../../../examples/simple-example.ts", cwd)),
         );
       }
     });
 
-    test("--redoc config", async () => {
-      await execa(cmd, ["--redoc", "test/fixtures/redocly-flag/redocly.yaml"], {
+    test("--redocly config", async () => {
+      await execa(cmd, ["--redocly", "test/fixtures/redocly-flag/redocly.yaml"], {
         cwd,
       });
       for (const schema of ["a", "b", "c"]) {
@@ -131,5 +131,18 @@ describe("CLI", () => {
         ).toMatchFileSnapshot(fileURLToPath(new URL("./examples/simple-example.ts", root)));
       }
     });
+
+    test.skipIf(os.platform() === "win32")("lint error", async () => {
+      const cwd = new URL("./fixtures/redocly-lint-error", import.meta.url);
+
+      try {
+        await execa("../../../bin/cli.js", {
+          cwd: fileURLToPath(cwd),
+        });
+        throw new Error("Linting should have thrown an error");
+      } catch (err) {
+        expect(stripAnsi(String(err))).toMatch(/✘ {2}Servers must be present/);
+      }
+    });
   });
 });

packages/openapi-typescript/test/fixtures/redocly-lint-error/.gitignore

@@ -0,0 +1 @@
+output

packages/openapi-typescript/test/fixtures/redocly-lint-error/openapi/openapi.yaml

@@ -0,0 +1,27 @@
+openapi: 3.1.0
+paths:
+  /:
+    get:
+      responses:
+        200:
+          content:
+            "application/json":
+              required: true
+              schema:
+                type: object
+                required:
+                  - success
+                properties:
+                  success:
+                    type: boolean
+        default:
+          content:
+            "application/json":
+              required: true
+              schema:
+                type: object
+                required:
+                  - status
+                properties:
+                  status:
+                    type: number