@farming-labs/docs 0.1.121 → 0.1.122

package/dist/cli/index.mjs

@@ -122,7 +122,7 @@ async function main() {
 		}
 		await runDoctor(doctorOptions);
 	} else if (parsedCommand.command === "review") {
-		const { parseReviewArgs, printReviewHelp, runReview } = await import("../review-BouPBEHv.mjs");
+		const { parseReviewArgs, printReviewHelp, runReview } = await import("../review-DEG_UnxV.mjs");
 		const reviewOptions = parseReviewArgs(args.slice(1));
 		if (reviewOptions.help) {
 			printReviewHelp();

package/dist/{review-SngQ_dxy.mjs → review-B7goPYUb.mjs}

@@ -3,6 +3,10 @@ import { dirname, isAbsolute, join, relative } from "node:path";
 
 //#region src/review.ts
 const DEFAULT_DOCS_REVIEW_WORKFLOW_PATH = ".github/workflows/docs-review.yml";
+const DEFAULT_DOCS_REVIEW_REUSABLE_WORKFLOW_PATH = ".github/workflows/docs-review-reusable.yml";
+const DEFAULT_DOCS_REVIEW_REUSABLE_WORKFLOW = "farming-labs/docs/.github/workflows/docs-review-reusable.yml@main";
+const LOCAL_DOCS_REVIEW_REUSABLE_WORKFLOW = "./.github/workflows/docs-review-reusable.yml";
+const DEFAULT_DOCS_REVIEW_PNPM_VERSION = "10";
 const DEFAULT_DOCS_REVIEW_SCORE_THRESHOLD = 80;
 const DEFAULT_DOCS_REVIEW_CI_NAME = "docs-review";
 const DEFAULT_REVIEW_RULES = {
@@ -87,12 +91,18 @@ function buildDocsReviewWorkflow(options = {}) {
 	const packageManager = options.packageManager ?? "npm";
 	const ciName = normalizeCiName(options.ciName);
 	const projectDir = normalizeProjectDir(options.projectDir);
-	const configArg = options.configPath ? ` --config ${shellQuote(options.configPath)}` : "";
-	const reviewCommand = `${options.reviewCommand ?? reviewCommandForPackageManager(packageManager)} review --ci${configArg}`;
+	const configPath = options.configPath ?? "docs.config.ts";
+	const reusableWorkflow = options.reusableWorkflow ?? DEFAULT_DOCS_REVIEW_REUSABLE_WORKFLOW;
 	const filters = normalizePathFilters(options.pathFilters);
-	const installSteps = buildInstallSteps(packageManager);
-	const buildStep = options.buildCommand ? `\n      - name: Build docs CLI\n        run: ${options.buildCommand}\n` : "";
-	const workingDirectoryLine = projectDir === "." ? "" : `\n        working-directory: ${projectDir}`;
+	const workflowInputs = [
+		["check-name", ciName],
+		["config", configPath],
+		["working-directory", projectDir],
+		["package-manager", packageManager],
+		options.pnpmVersion ? ["pnpm-version", options.pnpmVersion] : void 0,
+		options.buildCommand ? ["build-command", options.buildCommand] : void 0,
+		options.reviewCommand ? ["review-command", options.reviewCommand] : void 0
+	].filter((input) => Boolean(input)).map(([key, value]) => `      ${key}: ${JSON.stringify(value)}`).join("\n");
 	return `# Generated by @farming-labs/docs. You can edit this file.
 name: Docs Review
 
@@ -109,17 +119,13 @@ permissions:
 jobs:
   docs-review:
     name: ${JSON.stringify(ciName)}
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-
-${installSteps}
-${buildStep}
-
-      - name: Review docs
-        run: ${reviewCommand}${workingDirectoryLine}
+    uses: ${reusableWorkflow}
+    with:
+${workflowInputs}
+    permissions:
+      contents: read
+      checks: write
+      pull-requests: write
 `;
 }
 function ensureDocsReviewWorkflow(options) {
@@ -146,6 +152,8 @@ function ensureDocsReviewWorkflow(options) {
 	const workflow = buildDocsReviewWorkflow({
 		packageManager,
 		ciName: review.ci.name,
+		reusableWorkflow: hasLocalDocsWorkspacePackage(repoRoot) ? LOCAL_DOCS_REVIEW_REUSABLE_WORKFLOW : DEFAULT_DOCS_REVIEW_REUSABLE_WORKFLOW,
+		pnpmVersion: detectPnpmVersionFallback(repoRoot, packageManager),
 		projectDir,
 		configPath,
 		buildCommand: detectLocalDocsCliBuildCommand(repoRoot, packageManager),
@@ -209,7 +217,8 @@ function buildDocsReviewWorkflowPathFilters(options) {
 		prefixPath(projectPrefix, "content/docs/**"),
 		prefixPath(projectPrefix, "src/content/docs/**"),
 		prefixPath(projectPrefix, "src/lib/docs.config.*"),
-		DEFAULT_DOCS_REVIEW_WORKFLOW_PATH
+		DEFAULT_DOCS_REVIEW_WORKFLOW_PATH,
+		DEFAULT_DOCS_REVIEW_REUSABLE_WORKFLOW_PATH
 	];
 	return Array.from(new Set(candidates.filter((candidate) => Boolean(candidate))));
 }
@@ -270,6 +279,13 @@ function detectLocalDocsCliBuildCommand(repoRoot, packageManager) {
 	if (packageManager === "bun") return "bun run --filter @farming-labs/docs build";
 	return "npm run build --workspace=@farming-labs/docs";
 }
+function detectPnpmVersionFallback(repoRoot, packageManager) {
+	if (packageManager !== "pnpm") return void 0;
+	try {
+		if (JSON.parse(readFileSync(join(repoRoot, "package.json"), "utf-8")).packageManager?.startsWith("pnpm@")) return void 0;
+	} catch {}
+	return DEFAULT_DOCS_REVIEW_PNPM_VERSION;
+}
 function detectLocalDocsCliReviewCommand(repoRoot, rootDir) {
 	if (!hasLocalDocsWorkspacePackage(repoRoot)) return void 0;
 	return `node ${shellQuote(toPosixPath(relative(rootDir, join(repoRoot, "packages", "docs", "dist", "cli", "index.mjs"))) || "./packages/docs/dist/cli/index.mjs")}`;
@@ -284,44 +300,6 @@ function hasLocalDocsWorkspacePackage(repoRoot) {
 		return false;
 	}
 }
-function buildInstallSteps(packageManager) {
-	if (packageManager === "pnpm") return `      - uses: pnpm/action-setup@v4
-
-      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: pnpm
-
-      - name: Install dependencies
-        run: pnpm install --frozen-lockfile`;
-	if (packageManager === "yarn") return `      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: yarn
-
-      - name: Enable Corepack
-        run: corepack enable
-
-      - name: Install dependencies
-        run: yarn install --immutable || yarn install --frozen-lockfile`;
-	if (packageManager === "bun") return `      - uses: oven-sh/setup-bun@v2
-
-      - name: Install dependencies
-        run: bun install --frozen-lockfile`;
-	return `      - uses: actions/setup-node@v4
-        with:
-          node-version: 20
-          cache: npm
-
-      - name: Install dependencies
-        run: npm ci`;
-}
-function reviewCommandForPackageManager(packageManager) {
-	if (packageManager === "pnpm") return "pnpm exec docs";
-	if (packageManager === "yarn") return "yarn exec docs";
-	if (packageManager === "bun") return "bunx docs";
-	return "npx --no-install docs";
-}
 function shellQuote(value) {
 	if (/^[A-Za-z0-9_./:-]+$/.test(value)) return value;
 	return `'${value.replaceAll("'", "'\\''")}'`;

package/dist/{review-BouPBEHv.mjs → review-DEG_UnxV.mjs}

@@ -1,4 +1,4 @@
-import { a as ensureDocsReviewWorkflow, o as readDocsReviewConfigFromSource, s as resolveDocsReviewConfig } from "./review-SngQ_dxy.mjs";
+import { a as ensureDocsReviewWorkflow, o as readDocsReviewConfigFromSource, s as resolveDocsReviewConfig } from "./review-B7goPYUb.mjs";
 import { d as readTopLevelStringProperty, f as resolveDocsConfigPath, i as loadDocsConfigModule, p as resolveDocsContentDir } from "./config-BHRL4R2v.mjs";
 import matter from "gray-matter";
 import { existsSync, lstatSync, readFileSync, readdirSync } from "node:fs";

package/dist/server.d.mts

@@ -77,6 +77,8 @@ interface ResolvedDocsReviewConfig {
 interface DocsReviewWorkflowOptions {
   packageManager?: "npm" | "pnpm" | "yarn" | "bun";
   ciName?: string;
+  reusableWorkflow?: string;
+  pnpmVersion?: string;
   projectDir?: string;
   configPath?: string;
   buildCommand?: string;

package/dist/server.mjs

@@ -1,7 +1,7 @@
 import { A as resolveDocsAnalyticsConfig, D as emitDocsAgentTraceEvent, E as createDocsAgentTraceId, M as createDocsCloudAnalytics, O as emitDocsAnalyticsEvent, T as createDocsAgentTraceContext, a as createMcpSearchAdapter, c as formatDocsAskAIPackageHints, d as resolveAskAISearchRequestConfig, f as resolveSearchRequestConfig, i as createCustomSearchAdapter, j as resolveDocsObservabilityConfig, k as emitDocsObservabilityEvent, l as inferDocsAskAIPackageHints, n as buildDocsSearchDocuments, o as createSimpleSearchAdapter, r as createAlgoliaSearchAdapter, s as createTypesenseSearchAdapter, t as buildDocsAskAIContext, u as performDocsSearch, w as DOCS_AGENT_TRACE_EVENT_TYPES } from "./search-BL7o2rXk.mjs";
 import { a as buildDocsSitemapManifest, c as renderDocsSitemapMarkdown, d as resolveDocsSitemapPageLastmod, f as resolveDocsSitemapRequest, i as DEFAULT_SITEMAP_XML_ROUTE, l as renderDocsSitemapXml, n as DEFAULT_SITEMAP_MD_ROUTE, o as createDocsSitemapResponse, p as toDocsSitemapMarkdownUrl, r as DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, s as readDocsSitemapManifestFromContentMap, t as DEFAULT_SITEMAP_MANIFEST_PATH, u as resolveDocsSitemapConfig } from "./sitemap-CnqcTdQg.mjs";
 import { C as resolveApiReferenceOpenApiDiscovery, S as resolveApiReferenceConfig, _ as buildApiReferenceOpenApiDocument, a as DEFAULT_PROMPT_PROVIDER_TEMPLATES, b as buildApiReferenceScalarCss, c as resolvePromptProviderChoices, d as serializeDocsIconRegistry, f as serializeOpenDocsProvider, g as buildApiReferenceHtmlDocumentAsync, h as buildApiReferenceHtmlDocument, i as DEFAULT_OPEN_DOCS_TARGET, l as sanitizePromptText, m as DEFAULT_API_REFERENCE_OPENAPI_ROUTE, n as DEFAULT_OPEN_DOCS_PROMPT, o as normalizePromptProviderName, p as serializeOpenDocsProviders, r as DEFAULT_OPEN_DOCS_PROVIDER_IDS, s as parsePromptStringArray, t as readDocsSitemapManifest, u as serializeDocsIcon, v as buildApiReferenceOpenApiDocumentAsync, w as resolveApiReferenceRenderer, x as isApiReferenceOpenApiRequest, y as buildApiReferencePageTitle } from "./sitemap-server-DdHzJorR.mjs";
-import { a as ensureDocsReviewWorkflow, i as buildDocsReviewWorkflowPathFilters, n as DEFAULT_DOCS_REVIEW_WORKFLOW_PATH, o as readDocsReviewConfigFromSource, r as buildDocsReviewWorkflow, s as resolveDocsReviewConfig, t as DEFAULT_DOCS_REVIEW_SCORE_THRESHOLD } from "./review-SngQ_dxy.mjs";
+import { a as ensureDocsReviewWorkflow, i as buildDocsReviewWorkflowPathFilters, n as DEFAULT_DOCS_REVIEW_WORKFLOW_PATH, o as readDocsReviewConfigFromSource, r as buildDocsReviewWorkflow, s as resolveDocsReviewConfig, t as DEFAULT_DOCS_REVIEW_SCORE_THRESHOLD } from "./review-B7goPYUb.mjs";
 import { createDocsMcpHttpHandler, createDocsMcpServer, createFilesystemDocsMcpSource, normalizeDocsMcpRoute, resolveDocsMcpConfig, runDocsMcpStdio } from "./mcp.mjs";
 
 export { DEFAULT_API_REFERENCE_OPENAPI_ROUTE, DEFAULT_DOCS_REVIEW_SCORE_THRESHOLD, DEFAULT_DOCS_REVIEW_WORKFLOW_PATH, DEFAULT_OPEN_DOCS_PROMPT, DEFAULT_OPEN_DOCS_PROVIDER_IDS, DEFAULT_OPEN_DOCS_TARGET, DEFAULT_PROMPT_PROVIDER_TEMPLATES, DEFAULT_SITEMAP_MANIFEST_PATH, DEFAULT_SITEMAP_MD_ROUTE, DEFAULT_SITEMAP_MD_WELL_KNOWN_ROUTE, DEFAULT_SITEMAP_XML_ROUTE, DOCS_AGENT_TRACE_EVENT_TYPES, buildApiReferenceHtmlDocument, buildApiReferenceHtmlDocumentAsync, buildApiReferenceOpenApiDocument, buildApiReferenceOpenApiDocumentAsync, buildApiReferencePageTitle, buildApiReferenceScalarCss, buildDocsAskAIContext, buildDocsReviewWorkflow, buildDocsReviewWorkflowPathFilters, buildDocsSearchDocuments, buildDocsSitemapManifest, createAlgoliaSearchAdapter, createCustomSearchAdapter, createDocsAgentTraceContext, createDocsAgentTraceId, createDocsCloudAnalytics, createDocsMcpHttpHandler, createDocsMcpServer, createDocsSitemapResponse, createFilesystemDocsMcpSource, createMcpSearchAdapter, createSimpleSearchAdapter, createTypesenseSearchAdapter, emitDocsAgentTraceEvent, emitDocsAnalyticsEvent, emitDocsObservabilityEvent, ensureDocsReviewWorkflow, formatDocsAskAIPackageHints, inferDocsAskAIPackageHints, isApiReferenceOpenApiRequest, normalizeDocsMcpRoute, normalizePromptProviderName, parsePromptStringArray, performDocsSearch, readDocsReviewConfigFromSource, readDocsSitemapManifest, readDocsSitemapManifestFromContentMap, renderDocsSitemapMarkdown, renderDocsSitemapXml, resolveApiReferenceConfig, resolveApiReferenceOpenApiDiscovery, resolveApiReferenceRenderer, resolveAskAISearchRequestConfig, resolveDocsAnalyticsConfig, resolveDocsMcpConfig, resolveDocsObservabilityConfig, resolveDocsReviewConfig, resolveDocsSitemapConfig, resolveDocsSitemapPageLastmod, resolveDocsSitemapRequest, resolvePromptProviderChoices, resolveSearchRequestConfig, runDocsMcpStdio, sanitizePromptText, serializeDocsIcon, serializeDocsIconRegistry, serializeOpenDocsProvider, serializeOpenDocsProviders, toDocsSitemapMarkdownUrl };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@farming-labs/docs",
-  "version": "0.1.121",
+  "version": "0.1.122",
   "description": "Modern, flexible MDX-based docs framework — core types, config, and CLI",
   "keywords": [
     "docs",