feat: update the openapi transformer

src/docs/openapi.v2.yaml

@@ -1,7 +1,7 @@
 openapi: 3.0.0
 info:
   title: Simple Logging Server API
-  version: 2.2.0
+  version: 0.0.0
   description: |-
     This is a simple API for logging messages. It is intended to be a basic interface for logging messages according to an allowed list of clients.
     ### Usage

src/index.ts

@@ -13,10 +13,11 @@ import v2Router from "@/routers/v2";
 import docsRouter from "@/routers/docs";
 
 import { transformOpenapiYmlDoc, openapiYmlVersioner } from "@/utils/openapi-docs";
+import { getPackageInfo } from "@/utils/package";
 import { env } from "@/config/env";
 import type { ServerContext } from "@/types/hono";
 
-const packageJson = require("../package.json");
+const packageJson = getPackageInfo();
 
 const app = new Hono<ServerContext>();
 app.use(cors({ origin: "*" }));

src/utils/openapi-docs.ts

@@ -1,7 +1,7 @@
 import { join } from "node:path";
 import { readFileSync, writeFileSync } from "node:fs";
 
-type OpenApiDocTransformer = (dirVersion: string, doc: string) => string;
+type OpenApiDocTransformer = (filename: string, source_path: string, dirVersion: string, doc: string) => string;
 
 /**
  * Modify the OpenAPI doc with the provided transformers and write the file to the static directory.
@@ -16,25 +16,26 @@ export function transformOpenapiYmlDoc(dir_version: string, transformers: OpenAp
 
   let newOpenapiYmlDoc = openapiYmlInputDoc;
 
+  console.log(`📖 Starting to update /static/${openapiFilename}`);
+
   for (const transformer of transformers) {
-    newOpenapiYmlDoc = transformer(dir_version, newOpenapiYmlDoc);
+    newOpenapiYmlDoc = transformer(openapiFilename, openapiYmlSourcePath, dir_version, newOpenapiYmlDoc);
   }
 
   writeFileSync(openapiYmlOutPath, newOpenapiYmlDoc);
 
-  console.log(`📖 Updated /static/${openapiFilename}`);
+  console.log(`📖 Finishing updating /static/${openapiFilename}`);
   return;
 }
 
-const ymlVersionRegex = new RegExp(/^version: (0|[1-9]\d*)\.(0|[1-9]\d*)\.(0|[1-9]\d*)$/);
-
 /**
  * Transformer to update the version in the OpenAPI doc.
  * @param version
  * @returns
  */
 export function openapiYmlVersioner(version: string): OpenApiDocTransformer {
-  return (_, doc) => {
-    return doc.replace(ymlVersionRegex, `version: ${version}`);
+  return (filename, _, __, doc) => {
+    console.log(`📦 Updating the version in OpenAPI document "${filename}" to "${version}"`);
+    return doc.replace(/version:\s*0\.0\.0/g, `version: ${version}`);
   };
 }

src/utils/package.ts

@@ -0,0 +1,15 @@
+import { join } from "node:path";
+import { readFileSync } from "node:fs";
+import { z } from "zod";
+
+const PackageSchema = z.object({
+  name: z.string(),
+  version: z.string(),
+});
+
+export function getPackageInfo() {
+  const pathname = join(process.cwd(), "package.json");
+  const packageJson = JSON.parse(readFileSync(pathname, "utf8"));
+
+  return PackageSchema.parse(packageJson);
+}