add redocly docs generation (#4)

Author: SnakeDoc

README.md

@@ -38,12 +38,20 @@ See:
 
 Configure via the following environment variables:
 
-`OPENAPI_INPUT` - File to process (**default**: `./openapi/openapi.yaml`)
+`OPENAPI_INPUT` - File to process
 
-`OPENAPI_OUTPUT` - Where to write output file (**default**: `./dist/openapi.yaml`)
+- **default** `redocly-*` - `./openapi/openapi.yaml`
 
-`OPENAPI_FORMAT` - Output format (**default**: `yaml`)
+`OPENAPI_OUTPUT` - Where to write output file
 
-`OPENAPI_LINT_FORMAT` - Linter report format (**default**: `codeframe`)
+- **default** `redocly-bundle` - `./dist/openapi.yaml`
+- **default** `redocly-build-docs` - `./dist/openapi.html`
 
-`OPENAPI_CONFIG_PATH` - Path to redocly.yaml (**default**: `./redocly.yaml`)
+`OPENAPI_FORMAT` - Output format
+
+- **default** `redocly-bundle` - `yaml`
+- **default** `redocly-lint` - `codeframe`
+
+`OPENAPI_CONFIG_PATH` - Path to redocly.yaml
+
+- **default** `redocly-*` - `none` or `./redocly.yaml`

package.json

@@ -15,16 +15,18 @@
     "@bymbly:registry": "https://npm.pkg.github.com"
   },
   "bin": {
-    "openapi-bundle": "./dist/bin/bundle.js",
-    "openapi-lint": "./dist/bin/lint.js"
+    "redocly-bundle": "./dist/bin/redocly/bundle.js",
+    "redocly-lint": "./dist/bin/redocly/lint.js",
+    "redocly-build-docs": "./dist/bin/redocly/build-docs.js"
   },
   "scripts": {
     "build": "tsc",
     "watch": "tsc --watch",
     "prepublishOnly": "npm run build",
     "test": "vitest run",
     "test:watch": "vitest",
-    "test:ui": "vitest --ui"
+    "test:ui": "vitest --ui",
+    "test:update": "vitest --update"
   },
   "dependencies": {
     "@redocly/cli": "^2.12.3",

src/bin/bundle.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { buildDocs } from "../../lib/redocly/build-docs.js";
+
+buildDocs();

src/bin/lint.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { bundle } from "../../lib/redocly/bundle.js";
+
+bundle();

src/bin/redocly/build-docs.ts

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import { lint } from "../../lib/redocly/lint.js";
+
+lint();

src/bin/redocly/bundle.ts

@@ -0,0 +1,42 @@
+import { execSync } from "child_process";
+import { createPath } from "../utils.js";
+
+export interface BuildDocsOptions {
+  input: string;
+  output: string;
+  configPath?: string;
+}
+
+export function getOptions(): BuildDocsOptions {
+  return {
+    input: process.env.OPENAPI_INPUT || "openapi/openapi.yaml",
+    output: process.env.OPENAPI_OUTPUT || "dist/openapi.html",
+    configPath: process.env.OPENAPI_CONFIG,
+  };
+}
+
+export function buildDocs(): void {
+  const options = getOptions();
+
+  console.log(`📚 Building documentation...`);
+  console.log(`   Input: ${options.input}`);
+  console.log(`   Output: ${options.output}`);
+  console.log(`   Config: ${options.configPath || "default"}`);
+
+  let command = `npx --no @redocly/cli build-docs ${options.input} --output ${options.output}`;
+  if (options.configPath) {
+    command += ` --config ${options.configPath}`;
+  }
+
+  createPath(options.output);
+
+  try {
+    execSync(command, { stdio: "inherit" });
+
+    console.log(`✅ Documentation built successfully: ${options.output}`);
+  } catch (error) {
+    console.error(`❌ Building documentation failed!`);
+    console.error(`${error instanceof Error ? error.message : String(error)}`);
+    process.exit(1);
+  }
+}

src/bin/redocly/lint.ts

@@ -1,5 +1,5 @@
 import { execSync } from "child_process";
-import { createPath, createValidator } from "./utils.js";
+import { createPath, createValidator } from "../utils.js";
 
 const VALID_FORMATS = ["json", "yaml"] as const;
 export type Format = (typeof VALID_FORMATS)[number];

src/lib/redocly/build-docs.ts

@@ -1,5 +1,5 @@
 import { execSync } from "child_process";
-import { createValidator } from "./utils.js";
+import { createValidator } from "../utils.js";
 
 const VALID_FORMATS = [
   "codeframe",
@@ -23,7 +23,7 @@ const lintFormatValidator = createValidator(VALID_FORMATS);
 export const isValidLintFormat = lintFormatValidator.isValid;
 
 export function getOptions(): LintOptions {
-  const formatEnv = process.env.OPENAPI_LINT_FORMAT;
+  const formatEnv = process.env.OPENAPI_FORMAT;
   const format =
     formatEnv && isValidLintFormat(formatEnv) ? formatEnv : "codeframe";