feat: add quotes to yaml output

Author: GuptaSiddhant

packages/core/package.json

@@ -36,15 +36,16 @@
     "@remix-run/headers": "^0.16.0",
     "decompress": "^4.0.0",
     "hono": "^4.10.6",
+    "js-yaml": "^4.1.1",
     "zod": "^4.0.0"
   },
   "devDependencies": {
     "@types/decompress": "^4.0.0",
+    "@types/js-yaml": "^4.0.9",
     "@types/node": "^22.0.0",
     "@typescript/native-preview": "^7.0.0-dev.20251024.1",
     "@vitest/coverage-v8": "^3.2.4",
     "glob": "^10.0.0",
-    "js-yaml": "^4.1.1",
     "oxlint": "^1.24.0",
     "oxlint-tsgolint": "^0.3.0",
     "prettier": "^3.6.2",

packages/core/scripts/gen-openapi-spec-files.ts

@@ -12,7 +12,7 @@ export async function generateOpenApiSpecFiles(
   const outputYAMLFilepath = "./dist/openapi.yaml";
 
   const specJSONContent = JSON.stringify(spec, null, 2);
-  const specYAMLContent = YAML.dump(spec);
+  const specYAMLContent = YAML.dump(spec, { forceQuotes: true });
 
   await Promise.allSettled([
     writeFile(outputJSONFilepath, specJSONContent, { encoding: "utf8" }),

packages/core/scripts/post-build.ts

@@ -4,16 +4,10 @@ import { updateDenoJsonToMatchPkgJson } from "../../../scripts/jsr-utils.ts";
 import { generateOpenApiSpecFiles } from "./gen-openapi-spec-files.ts";
 
 export async function postBuildSuccess(config: ResolvedOptions): Promise<void> {
-  const { appRouter } = await import("../dist/router.js");
-  const { SERVICE_NAME } = await import("../dist/index.js");
-  const pkgJson = await import("../package.json", { with: { type: "json" } });
-
+  const { appRouter, openapiConfig } = await import("../dist/router.js");
   await generateOpenApiSpecFiles(
     config,
-    (appRouter as OpenAPIHono).getOpenAPI31Document({
-      info: { title: SERVICE_NAME, version: pkgJson.default.version },
-      openapi: "3.1.0",
-    }),
+    (appRouter as OpenAPIHono).getOpenAPI31Document(openapiConfig),
   );
 
   await updateDenoJsonToMatchPkgJson(config);

packages/core/src/index.ts

@@ -1,7 +1,6 @@
 import { OpenAPIHono } from "@hono/zod-openapi";
 import { SuperHeaders } from "@remix-run/headers";
 import { logger as loggerMiddleware } from "hono/logger";
-import pkgJson from "../package.json" with { type: "json" };
 import type { AuthAdapter, StoryBookerUser } from "./adapters";
 import { handlePurge, type HandlePurge } from "./handlers/handle-purge";
 import { appRouter } from "./routers/_app-router";
@@ -10,7 +9,7 @@ import type {
   RequestHandler,
   RequestHandlerOptions,
 } from "./types";
-import { DEFAULT_LOCALE, SERVICE_NAME } from "./utils/constants";
+import { DEFAULT_LOCALE } from "./utils/constants";
 import { parseErrorMessage } from "./utils/error";
 import { localStore } from "./utils/store";
 
@@ -37,10 +36,6 @@ export function createRequestHandler<User extends StoryBookerUser>(
   ]);
 
   const router = new OpenAPIHono({ strict: false })
-    .doc31("/openapi.json", {
-      openapi: "3.1.0",
-      info: { version: pkgJson.version, title: SERVICE_NAME },
-    })
     .use(loggerMiddleware(), ...(options.config?.middlewares || []))
     .route("/", appRouter);
 

packages/core/src/routers/_app-router.ts

@@ -1,5 +1,8 @@
 import { swaggerUI } from "@hono/swagger-ui";
 import { OpenAPIHono } from "@hono/zod-openapi";
+import YAML from "js-yaml";
+import pkgJson from "../../package.json" with { type: "json" };
+import { SERVICE_NAME } from "../utils/constants";
 import { getStore } from "../utils/store";
 import { createUIAdapterOptions } from "../utils/ui-utils";
 import { accountRouter } from "./account-router";
@@ -9,15 +12,26 @@ import { rootRouter } from "./root-router";
 import { tagsRouter } from "./tags-router";
 import { tasksRouter } from "./tasks-router";
 
+export const openapiConfig = {
+  openapi: "3.1.0",
+  info: { version: pkgJson.version, title: SERVICE_NAME },
+};
+
 export type AppRouter = typeof appRouter;
 export const appRouter = new OpenAPIHono({ strict: false })
+  .doc31("/openapi.json", openapiConfig)
+  .get("/openapi.yaml", (ctx) => {
+    const spec = (appRouter as OpenAPIHono).getOpenAPI31Document(openapiConfig);
+    const content: string = YAML.dump(spec, { forceQuotes: true });
+    return ctx.body(content, 200, { "Content-Type": "application/yaml" });
+  })
+  .get("/openapi", swaggerUI({ url: "/openapi.json" }))
   .route("/", rootRouter)
   .route("/", projectsRouter)
   .route("/", buildsRouter)
   .route("/", tagsRouter)
   .route("/tasks", tasksRouter)
   .route("/account", accountRouter)
-  .get("/openapi", swaggerUI({ url: "/openapi.json" }))
   .get("/:filepath{.+}", async (context) => {
     const { ui } = getStore();
     if (!ui?.handleUnhandledRoute) {

yarn.lock

@@ -7046,6 +7046,7 @@ __metadata:
     "@hono/zod-openapi": "npm:^1.1.5"
     "@remix-run/headers": "npm:^0.16.0"
     "@types/decompress": "npm:^4.0.0"
+    "@types/js-yaml": "npm:^4.0.9"
     "@types/node": "npm:^22.0.0"
     "@typescript/native-preview": "npm:^7.0.0-dev.20251024.1"
     "@vitest/coverage-v8": "npm:^3.2.4"
@@ -7885,6 +7886,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@types/js-yaml@npm:^4.0.9":
+  version: 4.0.9
+  resolution: "@types/js-yaml@npm:4.0.9"
+  checksum: 10c0/24de857aa8d61526bbfbbaa383aa538283ad17363fcd5bb5148e2c7f604547db36646440e739d78241ed008702a8920665d1add5618687b6743858fae00da211
+  languageName: node
+  linkType: hard
+
 "@types/json-schema@npm:*, @types/json-schema@npm:^7.0.15, @types/json-schema@npm:^7.0.8, @types/json-schema@npm:^7.0.9":
   version: 7.0.15
   resolution: "@types/json-schema@npm:7.0.15"