Packaging

.github/workflows/chunk-generator.yaml → .github/workflows/docs-md.yaml

@@ -1,4 +1,4 @@
-name: Chunk Generator
+name: Docs MD
 
 on:
   push:
@@ -9,7 +9,7 @@ on:
 
 jobs:
   build-and-test:
-    name: Chunk Generator Build and Test
+    name: Docs MD Build and Test
     runs-on: ubuntu-latest
 
     steps:
@@ -21,14 +21,14 @@ jobs:
       - name: Install dependencies
         run: npm ci
       - name: Lint
-        working-directory: ./packages/chunk-generator
+        working-directory: ./packages/docs-md
         run: npm run lint
       - name: Type check
-        working-directory: ./packages/chunk-generator
+        working-directory: ./packages/docs-md
         run: npm run type-check
       - name: Test
-        working-directory: ./packages/chunk-generator
+        working-directory: ./packages/docs-md
         run: npm run test
       - name: Build
-        working-directory: ./packages/chunk-generator
+        working-directory: ./packages/docs-md
         run: npm run build

.vscode/launch.json

@@ -11,7 +11,7 @@
       "skipFiles": [
         "<node_internals>/**"
       ],
-      "program": "${workspaceFolder}/packages/chunk-generator/src/cli/cli.ts",
+      "program": "${workspaceFolder}/packages/docs-md/src/cli/cli.ts",
       "runtimeArgs": ["--experimental-strip-types"],
       "cwd": "${workspaceFolder}/../mistral-docs"
     },
@@ -22,7 +22,7 @@
       "skipFiles": [
         "<node_internals>/**"
       ],
-      "program": "${workspaceFolder}/packages/chunk-generator/src/cli/cli.ts",
+      "program": "${workspaceFolder}/packages/docs-md/src/cli/cli.ts",
       "runtimeArgs": ["--experimental-strip-types"],
       "cwd": "${workspaceFolder}/../redis-demo-docs"
     },
@@ -33,7 +33,7 @@
       "skipFiles": [
         "<node_internals>/**"
       ],
-      "program": "${workspaceFolder}/packages/chunk-generator/src/cli/cli.ts",
+      "program": "${workspaceFolder}/packages/docs-md/src/cli/cli.ts",
       "runtimeArgs": ["--experimental-strip-types"],
       "cwd": "${workspaceFolder}/../apiture-docs-demo-docusaurus"
     },
@@ -44,7 +44,7 @@
       "skipFiles": [
         "<node_internals>/**"
       ],
-      "program": "${workspaceFolder}/packages/chunk-generator/src/cli/cli.ts",
+      "program": "${workspaceFolder}/packages/docs-md/src/cli/cli.ts",
       "runtimeArgs": ["--experimental-strip-types"],
       "cwd": "${workspaceFolder}/../speakeasy-docs-demo-nextra"
     },
@@ -55,7 +55,7 @@
       "skipFiles": [
         "<node_internals>/**"
       ],
-      "program": "${workspaceFolder}/packages/chunk-generator/src/cli/cli.ts",
+      "program": "${workspaceFolder}/packages/docs-md/src/cli/cli.ts",
       "runtimeArgs": ["--experimental-strip-types"],
       "cwd": "${workspaceFolder}/../speakeasy-docs-demo-docusaurus"
     },

package.json

@@ -11,7 +11,7 @@
     "typescript": "^5.8.3"
   },
   "workspaces": [
-    "packages/chunk-generator",
+    "packages/docs-md",
     "packages/config"
   ]
 }

packages/chunk-generator/package.json → packages/docs-md/package.json

@@ -1,10 +1,13 @@
 {
-  "name": "@speakeasy-api/chunk-generator",
-  "version": "1.0.0",
+  "name": "@speakeasy-api/docs-md",
+  "version": "0.1.0-beta1",
   "type": "module",
+  "bin": {
+    "docs-md": "dist/cli/cli.js"
+  },
   "scripts": {
     "test": "",
-    "build": "tsc && cp ./src/generator/docsData/*.gz ./dist/generator/docsData/",
+    "build": "tsc && cp ./src/generator/docsData/*.gz ./dist/generator/docsData/ && chmod a+x dist/cli/cli.js",
     "dev": "",
     "format": "prettier --config ../../prettier.config.mjs --ignore-path ../../.gitignore --write \"**/*.{js,jsx,mjs,ts,tsx,mts}\"",
     "lint": "eslint \"**/*.{js,jsx,mjs,ts,tsx,mts}\"",
@@ -29,4 +32,4 @@
     "motion": "^12.15.0",
     "zod": "^3.25.56"
   }
-}
+}

packages/chunk-generator/src/cli/cli.ts → packages/docs-md/src/cli/cli.ts

@@ -1,4 +1,4 @@
-#!/usr/bin/env node --experimental-strip-types
+#!/usr/bin/env node
 
 import {
   existsSync,
@@ -140,12 +140,18 @@ async function getSettings(): Promise<Settings> {
   }
 
   // Validate and format various settings, as needed
+  const configFileDirectory = dirname(configFilePath);
+  if (!isAbsolute(configFileContents.data.spec)) {
+    configFileContents.data.spec = resolve(
+      configFileDirectory,
+      configFileContents.data.spec
+    );
+  }
   if (!existsSync(configFileContents.data.spec)) {
     throw new Error(
       `OpenAPI spec file "${configFileContents.data.spec}" does not exist`
     );
   }
-  const configFileDirectory = dirname(configFilePath);
   if (!isAbsolute(configFileContents.data.output.pageOutDir)) {
     configFileContents.data.output.pageOutDir = resolve(
       configFileDirectory,
@@ -180,3 +186,5 @@ for (const [filename, contents] of Object.entries(pageContents)) {
     encoding: "utf-8",
   });
 }
+
+console.log("Success!");

packages/chunk-generator/src/generator/docsData/getDocsData.ts → packages/docs-md/src/generator/docsData/getDocsData.ts

@@ -23,6 +23,9 @@ const wasmPath = join(dirname(fileURLToPath(import.meta.url)), "lib.wasm.gz");
 export async function getDocsData(
   specContents: string
 ): Promise<Map<string, Chunk>> {
+  console.log(
+    "Parsing OpenAPI spec (you can ignore lock file errors printed below)"
+  );
   const gzippedBuffer = await readFile(wasmPath);
   const wasmBuffer = unzipSync(gzippedBuffer);
   const go = new Go();

packages/chunk-generator/src/generator/generatePages.ts → packages/docs-md/src/generator/generatePages.ts

@@ -21,5 +21,6 @@ export async function generatePages({
   const data = await getDocsData(specContents);
 
   // Generate the content
+  console.log("Generating Markdown pages");
   return generateContent(data);
 }