sourcey 3.5.1 → 3.5.2

package/README.md

@@ -2,11 +2,14 @@
 
 > Your API docs shouldn't depend on someone else's SaaS.
 
-Sourcey is an open source documentation platform. Point it at an OpenAPI spec, an MCP server, or a Doxygen XML directory; add markdown guides; get a complete docs site. Static HTML you own; no dashboard, no monthly bill, no API calls to render your own documentation. Deploy anywhere.
+Sourcey is an open source documentation platform. Point it at an OpenAPI spec, an MCP server, a Doxygen XML directory, or a Go module; add markdown guides; get a complete docs site. Static HTML you own; no dashboard, no monthly bill, no API calls to render your own documentation. Deploy anywhere.
 
 [![npm](https://img.shields.io/npm/v/sourcey)](https://www.npmjs.com/package/sourcey)
-[![build](https://img.shields.io/github/actions/workflow/status/sourcey/sourcey/ci.yml?branch=master)](https://github.com/sourcey/sourcey/actions)
+[![build](https://img.shields.io/github/actions/workflow/status/sourcey/sourcey/ci.yml?branch=main)](https://github.com/sourcey/sourcey/actions)
 [![node](https://img.shields.io/node/v/sourcey)](https://nodejs.org)
+[![license](https://img.shields.io/npm/l/sourcey)](LICENSE)
+[![Go Reference](https://pkg.go.dev/badge/github.com/sourcey/sourcey/go/sourcey-godoc.svg)](https://pkg.go.dev/github.com/sourcey/sourcey/go/sourcey-godoc)
+[![Go Report Card](https://goreportcard.com/badge/github.com/sourcey/sourcey/go/sourcey-godoc)](https://goreportcard.com/report/github.com/sourcey/sourcey/go/sourcey-godoc)
 
 ```bash
 npx sourcey init
@@ -23,6 +26,7 @@ npx sourcey init
 - **MCP server documentation**: tools, resources, prompts rendered as browsable reference with JSON-RPC, TypeScript, and Python code samples. Color-coded method types, annotation badges, connection config cards
 - **Markdown guides with rich components**: steps, cards, accordions, syntax-highlighted code blocks; prose docs alongside your API reference
 - **C++ and Doxygen**: feed Doxygen XML output, get modern searchable API docs. No new parser, no four-tool Breathe/Exhale/Sphinx pipeline
+- **Go and godoc**: native package documentation extracted from Go source via the toolchain. Render Go modules as Sourcey tabs, generate standalone static Go docs sites, or commit `godoc.json` snapshots for JS-only docs hosts. No Doxygen detour
 - **llms.txt generation**: auto-generate llms.txt and llms-full.txt alongside your HTML. Docs serve developers and AI agents from one build
 - **TypeScript config**: `sourcey.config.ts` with `defineConfig()` autocomplete; theme, navbar, CTA buttons, footer
 - **Theme presets**: default (sidebar + TOC), minimal (single column), api-first (Stripe-style three column); colors, fonts, layout dimensions, and custom CSS on top
@@ -32,6 +36,15 @@ npx sourcey init
 - **Static HTML output**: no framework runtime, no vendor lock-in. Deploy to GitHub Pages, Vercel, Netlify, S3, anywhere
 - **Open source**: AGPL-3.0. Self-host, fork, extend. Your docs, your infrastructure
 
+## OSS and Sourcey Cloud
+
+This repository is the public, local-first Sourcey product. Sourcey Cloud
+features that require hosted infrastructure, such as OAuth callbacks, CORS
+proxying, secret vaulting, hosted analytics, billing, and tenant control-plane
+APIs, are not implemented in this OSS package. When OSS features need a hosted
+runtime, they expose documented provider-neutral extension points instead of
+private Sourcey Cloud client code.
+
 ### Sourcey vs alternatives
 
 | | Sourcey | Redocly | GitBook | Mintlify | Fern | ReadMe |
@@ -41,6 +54,7 @@ npx sourcey init
 | Zero JS shipped | Yes | No | No | No | No | No |
 | MCP server docs | Native | No | No | No | No | No |
 | Doxygen / C++ docs | Native | No | No | No | No | No |
+| godoc / Go docs | Native | No | No | No | No | No |
 | Config format | TypeScript | YAML | GUI | JSON | YAML | GUI |
 | Local preview | Vite SSR | Local | Cloud | Local | Local | Cloud |
 | No account required | Yes | Partial | No | No | No | No |
@@ -49,18 +63,31 @@ npx sourcey init
 
 ## Install
 
+### Sourcey
+
 ```bash
-# npm (recommended)
+npm install -g sourcey
 npx sourcey init
+```
 
-# Homebrew
-brew tap sourcey/sourcey && brew install sourcey
+### Go docs generator
 
-# Docker
-docker run -v $(pwd):/docs sourcey/sourcey build
+```bash
+go install github.com/sourcey/sourcey/go/sourcey-godoc/cmd/sourcey-godoc@latest
+```
+
+### Homebrew
 
-# Nix
-nix run github:sourcey/sourcey
+```bash
+brew tap sourcey/tap
+brew install sourcey-godoc
+```
+
+### Scoop
+
+```powershell
+scoop bucket add sourcey https://github.com/sourcey/scoop-bucket
+scoop install sourcey-godoc
 ```
 
 ## Quick start
@@ -125,7 +152,57 @@ export default defineConfig({
 });
 ```
 
-Each tab is an `openapi` spec, an `mcp` snapshot, a `doxygen` directory, or `groups` of markdown pages. Pages are referenced by slug (e.g. `"quickstart"` resolves to `quickstart.md`).
+Each tab is an `openapi` spec, an `mcp` snapshot, a `doxygen` directory, a `godoc` Go module, or `groups` of markdown pages. Pages are referenced by slug (e.g. `"quickstart"` resolves to `quickstart.md`).
+
+### Go documentation (godoc)
+
+Add a Go module as a tab and Sourcey extracts package docs natively (no Doxygen pipeline):
+
+```typescript
+{
+  tab: "Go API",
+  godoc: {
+    module: ".",
+    packages: ["./internal/core/...", "./cmd/..."],
+    // sourceBasePath: "go/my-module" // repo-relative prefix for source links when module is not at repo root
+    // mode: "auto"   // default; live when Go is available, snapshot otherwise
+    // includeTests: true       // examples from *_test.go (default)
+    // includeUnexported: false // hide unexported symbols (default)
+  },
+}
+```
+
+The string shorthand is `godoc: "."` and expands to `{ module: ".", packages: ["./..."], mode: "auto", includeTests: true }`.
+
+`editBasePath` remains the global base for Markdown "Edit this page" links.
+Use `godoc.sourceBasePath` only when Go source files live under a different
+repository prefix than the docs source.
+
+Live mode invokes `go list` + `go/parser` + `go/doc` against the host Go toolchain. To pin a build environment for reproducibility, set `goEnv: { GOOS, GOARCH, tags }`.
+
+Snapshot mode reads a committed `godoc.json` and needs no Go on the build host. Generate it with:
+
+```bash
+sourcey godoc --module . --packages './...' --out docs/godoc.json
+```
+
+then point the tab at it:
+
+```typescript
+{
+  tab: "Go API",
+  godoc: { mode: "snapshot", snapshot: "./docs/godoc.json" },
+}
+```
+
+The extractor is also a standalone Go CLI for projects that want a native Go
+docs generator without installing the full Sourcey npm package:
+
+```bash
+go install github.com/sourcey/sourcey/go/sourcey-godoc/cmd/sourcey-godoc@latest
+sourcey-godoc generate --module . --packages './...' --out site
+sourcey-godoc snapshot --module . --packages './...' --out docs/godoc.json
+```
 
 ### Markdown components
 
@@ -171,6 +248,8 @@ sourcey dev                       Dev server (reads sourcey.config.ts)
 sourcey build                     Build site (reads sourcey.config.ts)
 sourcey build api.yaml            Quick build from a single spec
 sourcey validate api.yaml         Validate a spec file
+sourcey godoc --out godoc.json    Snapshot a Go module's docs to JSON
+sourcey-godoc generate --out site Standalone Go CLI for static godoc sites
 ```
 
 | Command | Flag | Description |
@@ -186,6 +265,7 @@ sourcey validate api.yaml         Validate a spec file
 git clone https://github.com/sourcey/sourcey.git
 cd sourcey && npm install
 npm run build && npm test
+cd go/sourcey-godoc && go test ./... && go vet ./...
 
 # Run the demo site
 cd demo && npx tsx ../src/cli.ts dev

package/dist/cli.js

@@ -1,9 +1,13 @@
 #!/usr/bin/env node
 import { defineCommand, runMain } from "citty";
+import { mkdir, writeFile } from "node:fs/promises";
+import { dirname, resolve } from "node:path";
 import { buildDocs, buildSiteDocs } from "./index.js";
 import { loadConfig } from "./config.js";
+import { runIntrospector, GodocIntrospectorError } from "./core/godoc-introspector.js";
+import { GODOC_SCHEMA_VERSION } from "./core/godoc-types.js";
 import { init } from "./init.js";
-import { formatChangelogDiagnostic } from "./site-assembly.js";
+import { formatChangelogDiagnostic, formatGodocDiagnostic } from "./site-assembly.js";
 import pkg from "../package.json" with { type: "json" };
 const build = defineCommand({
     meta: {
@@ -79,6 +83,7 @@ const build = defineCommand({
                 });
                 if (!args.quiet) {
                     logChangelogDiagnostics(result.changelogDiagnostics);
+                    logGodocDiagnostics(result.godocDiagnostics);
                     const elapsed = ((Date.now() - startTime) / 1000).toFixed(1);
                     console.log(`  Pages:  ${result.pageCount}`);
                     console.log(`  Output: ${result.outputDir}`);
@@ -155,17 +160,121 @@ const validate = defineCommand({
         }
     },
 });
+const godoc = defineCommand({
+    meta: {
+        name: "godoc",
+        description: "Snapshot a Go module's godoc data into a portable JSON file",
+    },
+    args: {
+        module: {
+            type: "string",
+            alias: ["m"],
+            description: "Go module directory (containing go.mod)",
+            default: ".",
+        },
+        packages: {
+            type: "string",
+            alias: ["p"],
+            description: "Package patterns (comma-separated)",
+            default: "./...",
+        },
+        exclude: {
+            type: "string",
+            description: "Import-path prefixes to exclude (comma-separated)",
+            required: false,
+        },
+        out: {
+            type: "string",
+            alias: ["o"],
+            description: "Output file path",
+            default: "godoc.json",
+        },
+        includeTests: {
+            type: "boolean",
+            description: "Include examples from *_test.go files",
+            default: true,
+        },
+        includeUnexported: {
+            type: "boolean",
+            description: "Include unexported symbols",
+            default: false,
+        },
+        quiet: {
+            type: "boolean",
+            alias: ["q"],
+            description: "Suppress output",
+            default: false,
+        },
+    },
+    async run({ args }) {
+        const moduleDir = resolve(process.cwd(), args.module);
+        const patterns = args.packages.split(",").map((p) => p.trim()).filter(Boolean);
+        const exclude = args.exclude
+            ? args.exclude.split(",").map((p) => p.trim()).filter(Boolean)
+            : [];
+        const outputPath = resolve(process.cwd(), args.out);
+        try {
+            const spec = await runIntrospector({
+                config: {
+                    module: moduleDir,
+                    packages: patterns.length > 0 ? patterns : ["./..."],
+                    mode: "live",
+                    includeTests: args.includeTests,
+                    includeUnexported: args.includeUnexported,
+                    hideUndocumented: false,
+                    exclude,
+                    sourceBasePath: "",
+                },
+            });
+            const snapshot = {
+                schema_version: GODOC_SCHEMA_VERSION,
+                source: "sourcey-godoc",
+                module_path: spec.modulePath,
+                generated_at: spec.generatedAt,
+                packages: spec.packages,
+                diagnostics: spec.diagnostics.length > 0 ? spec.diagnostics : undefined,
+            };
+            await mkdir(dirname(outputPath), { recursive: true });
+            await writeFile(outputPath, JSON.stringify(snapshot, null, 2) + "\n", "utf8");
+            const errors = spec.diagnostics.filter((d) => d.severity === "error");
+            const warnings = spec.diagnostics.filter((d) => d.severity === "warning");
+            if (!args.quiet) {
+                console.log(`\nSourcey: wrote godoc snapshot for ${spec.modulePath}`);
+                console.log(`  Packages:    ${spec.packages.length}`);
+                console.log(`  Output:      ${outputPath}`);
+                if (warnings.length > 0)
+                    console.log(`  Warnings:    ${warnings.length}`);
+                if (errors.length > 0)
+                    console.log(`  Errors:      ${errors.length}`);
+                for (const diag of spec.diagnostics) {
+                    const where = diag.package ? ` [${diag.package}]` : "";
+                    console.log(`    ${diag.severity}: ${diag.code}${where} ${diag.message}`);
+                }
+                console.log("");
+            }
+            if (errors.length > 0)
+                process.exit(1);
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            const code = error instanceof GodocIntrospectorError ? ` (${error.code})` : "";
+            console.error(`\nError${code}: ${message}\n`);
+            process.exit(1);
+        }
+    },
+});
 const main = defineCommand({
     meta: {
         name: "sourcey",
         version: pkg.version,
-        description: "Open source documentation platform for OpenAPI specs and markdown guides",
+        description: "Open source documentation platform for OpenAPI, MCP, Doxygen, godoc, and Markdown",
     },
     subCommands: {
         init,
         build,
         dev,
         validate,
+        godoc,
     },
     args: {
         spec: {
@@ -175,7 +284,11 @@ const main = defineCommand({
         },
     },
     async run({ args, rawArgs }) {
-        if (rawArgs.includes("init") || rawArgs.includes("build") || rawArgs.includes("dev") || rawArgs.includes("validate"))
+        if (rawArgs.includes("init") ||
+            rawArgs.includes("build") ||
+            rawArgs.includes("dev") ||
+            rawArgs.includes("validate") ||
+            rawArgs.includes("godoc"))
             return;
         if (args.spec) {
             await build.run({
@@ -199,4 +312,10 @@ function logChangelogDiagnostics(diagnostics) {
         console.log(`  ${formatChangelogDiagnostic(diagnostic)}`);
     }
 }
+function logGodocDiagnostics(diagnostics) {
+    for (const diagnostic of diagnostics) {
+        const writer = diagnostic.severity === "error" ? console.error : console.log;
+        writer(`  ${formatGodocDiagnostic(diagnostic)}`);
+    }
+}
 runMain(main);

package/dist/components/layout/Page.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Page.d.ts","sourceRoot":"","sources":["../../../src/components/layout/Page.tsx"],"names":[],"mappings":"AAoRA,wBAAgB,IAAI,iCAqCnB"}
+{"version":3,"file":"Page.d.ts","sourceRoot":"","sources":["../../../src/components/layout/Page.tsx"],"names":[],"mappings":"AAuRA,wBAAgB,IAAI,iCAqCnB"}

package/dist/components/layout/Page.js

@@ -68,7 +68,10 @@ function ContentFooter() {
             : undefined;
     if (site.repo && site.editBranch && editPath) {
         const repoBase = site.repo.replace(/\/$/, "");
-        const basePath = site.editBasePath ? `${site.editBasePath.replace(/^\/|\/$/g, "")}/` : "";
+        const editBasePath = page.kind === "markdown" && page.markdown.editBasePath !== undefined
+            ? page.markdown.editBasePath
+            : site.editBasePath;
+        const basePath = editBasePath ? `${editBasePath.replace(/^\/|\/$/g, "")}/` : "";
         editUrl = `${repoBase}/edit/${site.editBranch}/${basePath}${editPath}`;
     }
     const linkStyle = "hover:text-[rgb(var(--color-gray-600))] dark:hover:text-[rgb(var(--color-gray-300))] transition-colors";

package/dist/config.d.ts

@@ -105,6 +105,45 @@ export interface DoxygenConfig {
      */
     index?: DoxygenIndexStyle | false;
 }
+export type GodocMode = "auto" | "live" | "snapshot";
+export interface GodocGoEnv {
+    GOOS?: string;
+    GOARCH?: string;
+    tags?: string[];
+}
+export interface GodocConfig {
+    /** Module root (directory containing go.mod). Defaults to the directory containing sourcey.config.ts. */
+    module?: string;
+    /** Package patterns passed to `go list`, e.g. "./..." or "./internal/core/...". */
+    packages?: string[];
+    /** Optional path to a committed godoc snapshot (godoc.json). */
+    snapshot?: string;
+    /**
+     * Source mode.
+     * - "live": run the Go toolchain at build time.
+     * - "snapshot": read the committed snapshot file; no Go required.
+     * - "auto" (default): prefer live when Go is available; fall back to snapshot.
+     */
+    mode?: GodocMode;
+    /** Include package examples from *_test.go files (default: true). */
+    includeTests?: boolean;
+    /** Include unexported symbols (default: false). */
+    includeUnexported?: boolean;
+    /** Hide packages with no package comment from navigation (default: false). */
+    hideUndocumented?: boolean;
+    /** Package path prefixes to exclude after `go list` expansion. */
+    exclude?: string[];
+    /**
+     * Pin Go build environment for reproducible live-mode docs across hosts.
+     * When unset, live mode follows the host's GOOS/GOARCH and active tags.
+     */
+    goEnv?: GodocGoEnv;
+    /**
+     * Repository-relative base path for Go source links. Leave empty when the
+     * configured Go module is at the repository root.
+     */
+    sourceBasePath?: string;
+}
 export interface TabConfig {
     tab: string;
     /** Custom URL slug for this tab. Defaults to slugified tab name. */
@@ -114,6 +153,11 @@ export interface TabConfig {
     doxygen?: DoxygenConfig;
     /** Path to an mcp.json file (MCP server snapshot). */
     mcp?: string;
+    /**
+     * Native Go documentation. String shorthand expands to
+     * `{ module: <value>, packages: ["./..."], mode: "auto", includeTests: true }`.
+     */
+    godoc?: GodocConfig | string;
 }
 export interface GroupConfig {
     group: string;
@@ -194,6 +238,21 @@ export interface ResolvedDoxygenConfig {
     groups: boolean;
     index: DoxygenIndexStyle;
 }
+export interface ResolvedGodocConfig {
+    /** Absolute path to the Go module directory (containing go.mod). */
+    module: string;
+    /** Package patterns to pass to `go list`. Always at least one entry. */
+    packages: string[];
+    /** Absolute path to a snapshot file when configured. */
+    snapshot?: string;
+    mode: GodocMode;
+    includeTests: boolean;
+    includeUnexported: boolean;
+    hideUndocumented: boolean;
+    exclude: string[];
+    goEnv?: GodocGoEnv;
+    sourceBasePath: string;
+}
 export interface ResolvedTab {
     label: string;
     slug: string;
@@ -201,6 +260,7 @@ export interface ResolvedTab {
     groups?: ResolvedGroup[];
     doxygen?: ResolvedDoxygenConfig;
     mcp?: string;
+    godoc?: ResolvedGodocConfig;
 }
 export interface ResolvedPage {
     /** Original config slug (e.g. "run/index") */

package/dist/config.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAEhD,YAAY,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAMhD,MAAM,MAAM,WAAW,GAAG,SAAS,GAAG,SAAS,GAAG,WAAW,CAAC;AAE9D,MAAM,WAAW,WAAW;IAC1B,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,MAAM,CAAC,EAAE;QACP,OAAO,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;IACF,KAAK,CAAC,EAAE;QACN,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;IACF,MAAM,CAAC,EAAE;QACP,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;CAChB;AAED,MAAM,WAAW,eAAe;IAC9B,qFAAqF;IACrF,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,uDAAuD;IACvD,IAAI,CAAC,EAAE,OAAO,GAAG;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC1D,uDAAuD;IACvD,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,oEAAoE;IACpE,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gHAAgH;IAChH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,sFAAsF;IACtF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,GAAG;QACd,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iGAAiG;IACjG,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,6DAA6D;IAC7D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,sHAAsH;IACtH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iJAAiJ;IACjJ,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,UAAU,EAAE;QACV,IAAI,EAAE,SAAS,EAAE,CAAC;KACnB,CAAC;IACF,MAAM,CAAC,EAAE;QACP,KAAK,CAAC,EAAE,UAAU,EAAE,CAAC;QACrB,OAAO,CAAC,EAAE;YAAE,IAAI,EAAE,QAAQ,CAAC;YAAC,KAAK,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC;KAC3D,CAAC;IACF,MAAM,CAAC,EAAE;QACP,KAAK,CAAC,EAAE,UAAU,EAAE,CAAC;KACtB,CAAC;IACF,SAAS,CAAC,EAAE,KAAK,GAAG,eAAe,CAAC;IACpC,4BAA4B;IAC5B,MAAM,CAAC,EAAE;QACP,mFAAmF;QACnF,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;KACrB,CAAC;CACH;AAED,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,MAAM,GAAG,YAAY,GAAG,MAAM,GAAG,MAAM,CAAC;AAEjF,MAAM,WAAW,aAAa;IAC5B,2CAA2C;IAC3C,GAAG,EAAE,MAAM,CAAC;IACZ,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iDAAiD;IACjD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,iBAAiB,GAAG,KAAK,CAAC;CACnC;AAED,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,oEAAoE;IACpE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC;IACvB,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,sDAAsD;IACtD,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,MAAM,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,GAAG,OAAO,GAAG,UAAU,GAAG,SAAS,GAAG,QAAQ,GAAG,KAAK,GAAG,MAAM,CAAC;AAEhJ,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,aAAa,GAAG,aAAa,CAEjE;AAMD,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,WAAW,CAAC;IACpB,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IACzD,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC;IAC1D,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAC1D,GAAG,EAAE,MAAM,EAAE,CAAC;CACf;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,KAAK,GAAG;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACvD,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,UAAU,CAAC;IACvB,KAAK,EAAE,aAAa,CAAC;IACrB,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACxD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,IAAI,EAAE,WAAW,EAAE,CAAC;IACpB,MAAM,EAAE;QAAE,KAAK,EAAE,UAAU,EAAE,CAAC;QAAC,OAAO,CAAC,EAAE;YAAE,IAAI,EAAE,QAAQ,CAAC;YAAC,KAAK,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAC;IAC3F,MAAM,EAAE;QAAE,KAAK,EAAE,UAAU,EAAE,CAAA;KAAE,CAAC;IAChC,SAAS,EAAE,uBAAuB,CAAC;IACnC,MAAM,EAAE;QAAE,QAAQ,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;CAChC;AAED,MAAM,WAAW,qBAAqB;IACpC,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,OAAO,CAAC;IAChB,KAAK,EAAE,iBAAiB,CAAC;CAC1B;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,aAAa,EAAE,CAAC;IACzB,OAAO,CAAC,EAAE,qBAAqB,CAAC;IAChC,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,YAAY;IAC3B,8CAA8C;IAC9C,IAAI,EAAE,MAAM,CAAC;IACb,oDAAoD;IACpD,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,YAAY,EAAE,CAAC;CACvB;AAsBD,wBAAsB,UAAU,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CA8B9E;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,cAAc,CAqB/D;AAMD,wBAAsB,oBAAoB,CAAC,GAAG,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAgCzG;AAmMD,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE5C;AAED,wEAAwE;AACxE,wBAAgB,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAI7D;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,GAAG,MAAM,CAK5F;AAQD,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAO5C"}
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAEhD,YAAY,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAMhD,MAAM,MAAM,WAAW,GAAG,SAAS,GAAG,SAAS,GAAG,WAAW,CAAC;AAE9D,MAAM,WAAW,WAAW;IAC1B,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,MAAM,CAAC,EAAE;QACP,OAAO,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;IACF,KAAK,CAAC,EAAE;QACN,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;IACF,MAAM,CAAC,EAAE;QACP,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB,CAAC;IACF,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;CAChB;AAED,MAAM,WAAW,eAAe;IAC9B,qFAAqF;IACrF,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,uDAAuD;IACvD,IAAI,CAAC,EAAE,OAAO,GAAG;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IAC1D,uDAAuD;IACvD,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,oEAAoE;IACpE,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gHAAgH;IAChH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,sFAAsF;IACtF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,IAAI,CAAC,EAAE,MAAM,GAAG;QACd,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;KACf,CAAC;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iGAAiG;IACjG,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,6DAA6D;IAC7D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,sHAAsH;IACtH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,iJAAiJ;IACjJ,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB,UAAU,EAAE;QACV,IAAI,EAAE,SAAS,EAAE,CAAC;KACnB,CAAC;IACF,MAAM,CAAC,EAAE;QACP,KAAK,CAAC,EAAE,UAAU,EAAE,CAAC;QACrB,OAAO,CAAC,EAAE;YAAE,IAAI,EAAE,QAAQ,CAAC;YAAC,KAAK,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,CAAC;KAC3D,CAAC;IACF,MAAM,CAAC,EAAE;QACP,KAAK,CAAC,EAAE,UAAU,EAAE,CAAC;KACtB,CAAC;IACF,SAAS,CAAC,EAAE,KAAK,GAAG,eAAe,CAAC;IACpC,4BAA4B;IAC5B,MAAM,CAAC,EAAE;QACP,mFAAmF;QACnF,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;KACrB,CAAC;CACH;AAED,MAAM,MAAM,iBAAiB,GAAG,MAAM,GAAG,MAAM,GAAG,YAAY,GAAG,MAAM,GAAG,MAAM,CAAC;AAEjF,MAAM,WAAW,aAAa;IAC5B,2CAA2C;IAC3C,GAAG,EAAE,MAAM,CAAC;IACZ,4CAA4C;IAC5C,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iDAAiD;IACjD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;;;;;;OAOG;IACH,KAAK,CAAC,EAAE,iBAAiB,GAAG,KAAK,CAAC;CACnC;AAED,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC;AAErD,MAAM,WAAW,UAAU;IACzB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,WAAW,WAAW;IAC1B,yGAAyG;IACzG,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mFAAmF;IACnF,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,gEAAgE;IAChE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,qEAAqE;IACrE,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,mDAAmD;IACnD,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,8EAA8E;IAC9E,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,kEAAkE;IAClE,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB;;;OAGG;IACH,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,SAAS;IACxB,GAAG,EAAE,MAAM,CAAC;IACZ,oEAAoE;IACpE,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC;IACvB,OAAO,CAAC,EAAE,aAAa,CAAC;IACxB,sDAAsD;IACtD,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,KAAK,CAAC,EAAE,WAAW,GAAG,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,EAAE,CAAC;CACjB;AAED,MAAM,MAAM,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS,GAAG,OAAO,GAAG,UAAU,GAAG,SAAS,GAAG,QAAQ,GAAG,KAAK,GAAG,MAAM,CAAC;AAEhJ,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,QAAQ,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,wBAAgB,YAAY,CAAC,MAAM,EAAE,aAAa,GAAG,aAAa,CAEjE;AAMD,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,WAAW,CAAC;IACpB,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IACzD,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC;IAC1D,MAAM,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAC1D,GAAG,EAAE,MAAM,EAAE,CAAC;CACf;AAED,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,OAAO,CAAC;IACjB,IAAI,EAAE,KAAK,GAAG;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACvD,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,UAAU,CAAC;IACvB,KAAK,EAAE,aAAa,CAAC;IACrB,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACxD,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,IAAI,EAAE,WAAW,EAAE,CAAC;IACpB,MAAM,EAAE;QAAE,KAAK,EAAE,UAAU,EAAE,CAAC;QAAC,OAAO,CAAC,EAAE;YAAE,IAAI,EAAE,QAAQ,CAAC;YAAC,KAAK,EAAE,MAAM,CAAC;YAAC,IAAI,EAAE,MAAM,CAAA;SAAE,CAAA;KAAE,CAAC;IAC3F,MAAM,EAAE;QAAE,KAAK,EAAE,UAAU,EAAE,CAAA;KAAE,CAAC;IAChC,SAAS,EAAE,uBAAuB,CAAC;IACnC,MAAM,EAAE;QAAE,QAAQ,EAAE,MAAM,EAAE,CAAA;KAAE,CAAC;CAChC;AAED,MAAM,WAAW,qBAAqB;IACpC,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,OAAO,CAAC;IAChB,KAAK,EAAE,iBAAiB,CAAC;CAC1B;AAED,MAAM,WAAW,mBAAmB;IAClC,oEAAoE;IACpE,MAAM,EAAE,MAAM,CAAC;IACf,wEAAwE;IACxE,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,wDAAwD;IACxD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,SAAS,CAAC;IAChB,YAAY,EAAE,OAAO,CAAC;IACtB,iBAAiB,EAAE,OAAO,CAAC;IAC3B,gBAAgB,EAAE,OAAO,CAAC;IAC1B,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,aAAa,EAAE,CAAC;IACzB,OAAO,CAAC,EAAE,qBAAqB,CAAC;IAChC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,KAAK,CAAC,EAAE,mBAAmB,CAAC;CAC7B;AAED,MAAM,WAAW,YAAY;IAC3B,8CAA8C;IAC9C,IAAI,EAAE,MAAM,CAAC;IACb,oDAAoD;IACpD,IAAI,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,YAAY,EAAE,CAAC;CACvB;AAsBD,wBAAsB,UAAU,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CA8B9E;AAED;;GAEG;AACH,wBAAgB,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,cAAc,CAqB/D;AAMD,wBAAsB,oBAAoB,CAAC,GAAG,EAAE,aAAa,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC,CAgCzG;AAwND,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAE5C;AAED,wEAAwE;AACxE,wBAAgB,OAAO,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,CAI7D;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,GAAG,MAAM,CAK5F;AAQD,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAO5C"}

package/dist/config.js

@@ -168,12 +168,12 @@ async function resolveTabs(tabs, configDir) {
         if (slugs.has(slug))
             throw new Error(`Duplicate tab slug "${slug}" (from "${tab.tab}")`);
         slugs.add(slug);
-        const sources = [tab.openapi, tab.groups, tab.doxygen, tab.mcp].filter(Boolean).length;
+        const sources = [tab.openapi, tab.groups, tab.doxygen, tab.mcp, tab.godoc].filter(Boolean).length;
         if (sources > 1) {
-            throw new Error(`Tab "${tab.tab}" has multiple sources; use only one of "openapi", "groups", "doxygen", or "mcp"`);
+            throw new Error(`Tab "${tab.tab}" has multiple sources; use only one of "openapi", "groups", "doxygen", "mcp", or "godoc"`);
         }
         if (sources === 0) {
-            throw new Error(`Tab "${tab.tab}" needs one of "openapi", "groups", "doxygen", or "mcp"`);
+            throw new Error(`Tab "${tab.tab}" needs one of "openapi", "groups", "doxygen", "mcp", or "godoc"`);
         }
         if (tab.openapi) {
             if (isUrl(tab.openapi)) {
@@ -209,6 +209,28 @@ async function resolveTabs(tabs, configDir) {
                 },
             });
         }
+        else if (tab.godoc) {
+            const cfg = typeof tab.godoc === "string" ? { module: tab.godoc } : tab.godoc;
+            const moduleAbs = resolve(configDir, cfg.module ?? ".");
+            await assertExists(moduleAbs, `Go module directory "${cfg.module ?? "."}" in tab "${tab.tab}"`);
+            const snapshotAbs = cfg.snapshot ? resolve(configDir, cfg.snapshot) : undefined;
+            resolved.push({
+                label: tab.tab,
+                slug,
+                godoc: {
+                    module: moduleAbs,
+                    packages: cfg.packages?.length ? cfg.packages : ["./..."],
+                    snapshot: snapshotAbs,
+                    mode: cfg.mode ?? "auto",
+                    includeTests: cfg.includeTests ?? true,
+                    includeUnexported: cfg.includeUnexported ?? false,
+                    hideUndocumented: cfg.hideUndocumented ?? false,
+                    exclude: cfg.exclude ?? [],
+                    goEnv: cfg.goEnv,
+                    sourceBasePath: trimSlashes(cfg.sourceBasePath ?? ""),
+                },
+            });
+        }
         else {
             const groups = await resolveGroups(tab.groups, tab.tab, configDir);
             resolved.push({ label: tab.tab, slug, groups });
@@ -325,6 +347,9 @@ export function hexToRgb(hex) {
     const b = parseInt(h.slice(4, 6), 16);
     return `${r} ${g} ${b}`;
 }
+function trimSlashes(path) {
+    return path.replace(/^\/+|\/+$/g, "");
+}
 async function assertExists(filePath, label) {
     try {
         await access(filePath);

package/dist/core/godoc-introspector.d.ts

@@ -0,0 +1,26 @@
+import type { ResolvedGodocConfig } from "../config.js";
+import type { GodocSpec } from "./godoc-types.js";
+export declare class GodocIntrospectorError extends Error {
+    readonly code: string;
+    readonly cause?: Error | undefined;
+    constructor(code: string, message: string, cause?: Error);
+}
+export interface IntrospectOptions {
+    config: ResolvedGodocConfig;
+    /** Override the Go executable; defaults to "go" on PATH. */
+    goBinary?: string;
+}
+/**
+ * Run the Go introspector and return a parsed GodocSpec.
+ *
+ * Live mode invokes `go run` against the bundled helper, with `GOOS`/`GOARCH`
+ * and build tags pinned by `goEnv` when configured. Throws a structured
+ * `GodocIntrospectorError` on failure so callers can surface the right
+ * diagnostic kind.
+ */
+export declare function runIntrospector(opts: IntrospectOptions): Promise<GodocSpec>;
+/** Helper entry paths, exported for tests that pin the runtime. */
+export declare const __helperEntryCandidatesForTests: string[];
+/** Resolve the helper entry path relative to a given module directory.  */
+export declare function resolveHelperPath(fromDir: string): string;
+//# sourceMappingURL=godoc-introspector.d.ts.map

package/dist/core/godoc-introspector.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"godoc-introspector.d.ts","sourceRoot":"","sources":["../../src/core/godoc-introspector.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AACxD,OAAO,KAAK,EAAiB,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAQjE,qBAAa,sBAAuB,SAAQ,KAAK;IAC/C,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,CAAC,EAAE,KAAK,GAAG,SAAS,CAAC;gBACvB,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK;CAMzD;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,mBAAmB,CAAC;IAC5B,4DAA4D;IAC5D,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED;;;;;;;GAOG;AACH,wBAAsB,eAAe,CAAC,IAAI,EAAE,iBAAiB,GAAG,OAAO,CAAC,SAAS,CAAC,CAgDjF;AAwGD,mEAAmE;AACnE,eAAO,MAAM,+BAA+B,UAG3C,CAAC;AAEF,2EAA2E;AAC3E,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAEzD"}