flowdoc-gen 0.1.0

package/README.md

@@ -0,0 +1,89 @@
+# flowdoc
+
+Auto-generate beautiful API documentation from your Express codebase — no annotations required.
+
+flowdoc scans your TypeScript source files, extracts Express routes, infers Zod schemas, and produces an interactive docs UI served directly from your server.
+
+## Install
+
+```bash
+npm install flowdoc-gen
+# or
+pnpm add flowdoc-gen
+```
+
+## Quick start
+
+### 1. Scaffold a config
+
+```bash
+npx flowdoc init
+```
+
+This creates `flowdoc.config.ts` in your project root.
+
+### 2. Serve docs from your own Express server
+
+```ts
+import express from "express";
+import { flowdoc } from "flowdoc-gen";
+
+const app = express();
+app.use("/docs", flowdoc());
+
+app.listen(3000);
+// Docs are live at http://localhost:3000/docs
+```
+
+The `baseUrl` is auto-detected from every incoming request — no manual config needed.
+
+### 3. Or generate a static site
+
+```bash
+npx flowdoc generate        # writes docs-output/
+npx flowdoc serve           # generate + open in browser
+npx flowdoc serve --watch   # re-generate on file changes
+```
+
+## CLI reference
+
+| Command | Description |
+|---------|-------------|
+| `flowdoc init` | Scaffold `flowdoc.config.ts` |
+| `flowdoc generate` | Parse routes and write `docs-output/` |
+| `flowdoc serve` | Generate and open docs in browser |
+| `flowdoc serve --watch` | Same, but re-generates on source changes |
+| `flowdoc serve --port 5000` | Custom port (default 4000) |
+
+## Config
+
+```ts
+// flowdoc.config.ts
+import { defineConfig } from "flowdoc-gen";
+
+export default defineConfig({
+  name: "My API",
+  entry: "src/**/*.ts",
+  framework: "express",
+  output: "docs-output",
+  groups: [
+    { name: "Auth",  match: "/auth/**" },
+    { name: "Users", match: "/users/**" },
+  ],
+  theme: {
+    brand: "#6366f1",
+    darkMode: true,
+  },
+});
+```
+
+## What gets inferred automatically
+
+- All Express routes (`app.get`, `app.post`, `router.use`, etc.)
+- Path parameters (`/users/:id` → `id: string` in path params)
+- Zod request body schemas passed to validation middleware
+- Route grouping by path prefix
+
+## License
+
+MIT

package/dist/bin.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env node

package/dist/bin.js

@@ -0,0 +1,31 @@
+#!/usr/bin/env node
+#!/usr/bin/env node
+
+// src/bin.ts
+import { program } from "commander";
+import { readFileSync } from "fs";
+import { fileURLToPath } from "url";
+import { dirname, join } from "path";
+var __dirname = dirname(fileURLToPath(import.meta.url));
+var pkg = JSON.parse(readFileSync(join(__dirname, "../package.json"), "utf-8"));
+program.name("flowdoc").description("Auto-generate beautiful API documentation from your Express codebase").version(pkg.version);
+program.command("init").description("Scaffold a flowdoc.config.ts in the current directory").action(async () => {
+  const { init } = await import("./init-27XS6ADW.js");
+  init();
+});
+program.command("generate").description("Parse your routes and write docs to the output folder").option("-c, --config <path>", "Path to flowdoc config file").option("-o, --output <path>", "Override output directory").option("-q, --quiet", "Suppress output").action(async (opts) => {
+  const { generate } = await import("./generate-J6FGBLQ4.js");
+  await generate(opts);
+});
+program.command("serve").description("Generate docs and serve them locally").option("-c, --config <path>", "Path to flowdoc config file").option("-o, --output <path>", "Override output directory").option("-p, --port <number>", "Port to serve on (default: 4000)", "4000").option("-w, --watch", "Re-generate docs on source file changes").option("--no-open", "Don't open browser automatically").action(async (opts) => {
+  const { serve } = await import("./serve-Y4E3DTAJ.js");
+  const serveOpts = {
+    port: opts.port ? parseInt(opts.port, 10) : 4e3,
+    noOpen: !opts.open,
+    watch: opts.watch ?? false
+  };
+  if (opts.config !== void 0) serveOpts.config = opts.config;
+  if (opts.output !== void 0) serveOpts.output = opts.output;
+  await serve(serveOpts);
+});
+program.parse();