docs-ready 0.3.0 → 0.6.0

package/dist/{generate-LDVEG2WV.js → generate-4EHDLBJX.js}

@@ -1,216 +1,23 @@
 #!/usr/bin/env node
+import {
+  estimateTokens,
+  formatTokens,
+  scanDocs
+} from "./chunk-4NYEWEU2.js";
+import {
+  loadConfig
+} from "./chunk-QI2AROM3.js";
 import {
   log,
   spinner
 } from "./chunk-7YN54Y4Y.js";
 
 // src/cli/commands/generate.ts
-import fs3 from "fs/promises";
-import path5 from "path";
-
-// src/core/config.ts
 import fs from "fs/promises";
-import path from "path";
-import YAML from "yaml";
-var DEFAULTS = {
-  docs: {
-    dir: "./docs",
-    include: ["**/*.md", "**/*.mdx"],
-    exclude: ["**/node_modules/**", "**/_*"]
-  },
-  generate: {
-    llms_txt: true,
-    llms_full_txt: true,
-    ai_context: true,
-    output_dir: "./build"
-  },
-  guard: {
-    npm_packages: [],
-    github_releases: [],
-    endpoints: [],
-    readme_scans: [],
-    workflow: {
-      enabled: true,
-      schedule: "0 9 */3 * *",
-      create_issues: true,
-      labels: ["ai-context-review", "documentation"]
-    }
-  },
-  deploy: {
-    platform: "none",
-    cors: { enabled: true, origins: ["*"] }
-  },
-  validate: {
-    max_tokens: 15e4,
-    check_links: true,
-    check_coverage: true,
-    coverage_threshold: 0.95
-  }
-};
-var CONFIG_FILES = [
-  { name: ".docs-ready.yaml", parser: "yaml" },
-  { name: ".docs-ready.yml", parser: "yaml" },
-  { name: ".docs-ready.json", parser: "json" },
-  { name: ".docs-ready.toml", parser: "toml" }
-];
-async function loadConfig(dir, configPath) {
-  let raw;
-  if (configPath) {
-    const content = await fs.readFile(configPath, "utf-8");
-    raw = parseConfig(content, configPath);
-  } else {
-    for (const { name, parser } of CONFIG_FILES) {
-      const fullPath = path.join(dir, name);
-      try {
-        const content = await fs.readFile(fullPath, "utf-8");
-        if (parser === "toml") {
-          throw new Error("TOML support requires a TOML parser. Use .yaml or .json instead.");
-        }
-        raw = parseConfig(content, fullPath);
-        break;
-      } catch (err) {
-        if (err.code === "ENOENT") continue;
-        throw err;
-      }
-    }
-  }
-  if (!raw) {
-    throw new Error(
-      "No config file found. Run `docs-ready init` to create one, or create .docs-ready.yaml manually."
-    );
-  }
-  validate(raw);
-  return applyDefaults(raw);
-}
-function parseConfig(content, filePath) {
-  if (filePath.endsWith(".json")) {
-    return JSON.parse(content);
-  }
-  const parsed = YAML.parse(content);
-  if (parsed === null || typeof parsed !== "object") {
-    throw new Error(`Failed to parse config file: ${filePath}`);
-  }
-  return parsed;
-}
-function validate(raw) {
-  const missing = [];
-  if (!raw.title || typeof raw.title !== "string") missing.push("title");
-  if (!raw.description || typeof raw.description !== "string") missing.push("description");
-  if (!raw.url || typeof raw.url !== "string") missing.push("url");
-  if (missing.length > 0) {
-    throw new Error(
-      `Missing required config fields: ${missing.join(", ")}. Add them to your .docs-ready.yaml file.`
-    );
-  }
-}
-function applyDefaults(raw) {
-  const docs = raw.docs;
-  const generate = raw.generate;
-  const guard = raw.guard;
-  const deploy = raw.deploy;
-  const validateConf = raw.validate;
-  const guardWorkflow = guard?.workflow ?? {};
-  return {
-    title: raw.title,
-    description: raw.description,
-    url: raw.url,
-    docs: {
-      dir: docs?.dir ?? DEFAULTS.docs.dir,
-      include: docs?.include ?? DEFAULTS.docs.include,
-      exclude: docs?.exclude ?? DEFAULTS.docs.exclude
-    },
-    generate: {
-      llms_txt: generate?.llms_txt ?? DEFAULTS.generate.llms_txt,
-      llms_full_txt: generate?.llms_full_txt ?? DEFAULTS.generate.llms_full_txt,
-      ai_context: generate?.ai_context ?? DEFAULTS.generate.ai_context,
-      output_dir: generate?.output_dir ?? DEFAULTS.generate.output_dir,
-      sections: generate?.sections,
-      ai_context_config: generate?.ai_context_config
-    },
-    guard: {
-      npm_packages: guard?.npm_packages ?? DEFAULTS.guard.npm_packages,
-      github_releases: guard?.github_releases ?? DEFAULTS.guard.github_releases,
-      endpoints: guard?.endpoints ?? DEFAULTS.guard.endpoints,
-      readme_scans: guard?.readme_scans ?? DEFAULTS.guard.readme_scans,
-      workflow: {
-        enabled: guardWorkflow.enabled ?? DEFAULTS.guard.workflow.enabled,
-        schedule: guardWorkflow.schedule ?? DEFAULTS.guard.workflow.schedule,
-        create_issues: guardWorkflow.create_issues ?? DEFAULTS.guard.workflow.create_issues,
-        labels: guardWorkflow.labels ?? DEFAULTS.guard.workflow.labels
-      }
-    },
-    deploy: {
-      platform: deploy?.platform ?? DEFAULTS.deploy.platform,
-      cors: {
-        enabled: deploy?.cors?.enabled ?? DEFAULTS.deploy.cors.enabled,
-        origins: deploy?.cors?.origins ?? DEFAULTS.deploy.cors.origins
-      }
-    },
-    validate: {
-      max_tokens: validateConf?.max_tokens ?? DEFAULTS.validate.max_tokens,
-      check_links: validateConf?.check_links ?? DEFAULTS.validate.check_links,
-      check_coverage: validateConf?.check_coverage ?? DEFAULTS.validate.check_coverage,
-      coverage_threshold: validateConf?.coverage_threshold ?? DEFAULTS.validate.coverage_threshold
-    }
-  };
-}
-
-// src/core/scanner.ts
-import fs2 from "fs/promises";
-import path2 from "path";
-import matter from "gray-matter";
-import { glob } from "glob";
-async function scanDocs(docsDir, options) {
-  const resolvedDir = path2.resolve(docsDir);
-  const allFiles = [];
-  for (const pattern of options.include) {
-    const matches = await glob(pattern, {
-      cwd: resolvedDir,
-      ignore: options.exclude,
-      nodir: true,
-      absolute: false
-    });
-    allFiles.push(...matches);
-  }
-  const uniqueFiles = [...new Set(allFiles)];
-  const pages = [];
-  for (const relativePath of uniqueFiles) {
-    const filePath = path2.join(resolvedDir, relativePath);
-    const raw = await fs2.readFile(filePath, "utf-8");
-    const { data: frontmatter, content } = matter(raw);
-    const title = resolveTitle(frontmatter, content, relativePath);
-    const description = frontmatter.description ?? null;
-    pages.push({
-      filePath,
-      relativePath: relativePath.replace(/\\/g, "/"),
-      title,
-      description,
-      frontmatter,
-      content
-    });
-  }
-  pages.sort((a, b) => {
-    const posA = a.frontmatter.sidebar_position ?? Infinity;
-    const posB = b.frontmatter.sidebar_position ?? Infinity;
-    if (posA !== posB) return posA - posB;
-    return a.relativePath.localeCompare(b.relativePath);
-  });
-  return pages;
-}
-function resolveTitle(frontmatter, content, relativePath) {
-  if (typeof frontmatter.title === "string" && frontmatter.title.trim()) {
-    return frontmatter.title.trim();
-  }
-  const h1Match = content.match(/^#\s+(.+)$/m);
-  if (h1Match) {
-    return h1Match[1].trim();
-  }
-  const basename = path2.basename(relativePath, path2.extname(relativePath));
-  return basename.charAt(0).toUpperCase() + basename.slice(1).replace(/[-_]/g, " ");
-}
+import path3 from "path";
 
 // src/generate/llms-txt.ts
-import path4 from "path";
+import path2 from "path";
 
 // node_modules/balanced-match/dist/esm/index.js
 var balanced = (a, b, str) => {
@@ -456,9 +263,9 @@ var posixClasses = {
 var braceEscape = (s) => s.replace(/[[\]\\-]/g, "\\$&");
 var regexpEscape = (s) => s.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
 var rangesToString = (ranges) => ranges.join("");
-var parseClass = (glob2, position) => {
+var parseClass = (glob, position) => {
   const pos = position;
-  if (glob2.charAt(pos) !== "[") {
+  if (glob.charAt(pos) !== "[") {
     throw new Error("not in a brace expression");
   }
   const ranges = [];
@@ -470,8 +277,8 @@ var parseClass = (glob2, position) => {
   let negate = false;
   let endPos = pos;
   let rangeStart = "";
-  WHILE: while (i < glob2.length) {
-    const c = glob2.charAt(i);
+  WHILE: while (i < glob.length) {
+    const c = glob.charAt(i);
     if ((c === "!" || c === "^") && i === pos + 1) {
       negate = true;
       i++;
@@ -491,9 +298,9 @@ var parseClass = (glob2, position) => {
     }
     if (c === "[" && !escaping) {
       for (const [cls, [unip, u, neg]] of Object.entries(posixClasses)) {
-        if (glob2.startsWith(cls, i)) {
+        if (glob.startsWith(cls, i)) {
           if (rangeStart) {
-            return ["$.", false, glob2.length - pos, true];
+            return ["$.", false, glob.length - pos, true];
           }
           i += cls.length;
           if (neg)
@@ -516,12 +323,12 @@ var parseClass = (glob2, position) => {
       i++;
       continue;
     }
-    if (glob2.startsWith("-]", i + 1)) {
+    if (glob.startsWith("-]", i + 1)) {
       ranges.push(braceEscape(c + "-"));
       i += 2;
       continue;
     }
-    if (glob2.startsWith("-", i + 1)) {
+    if (glob.startsWith("-", i + 1)) {
       rangeStart = c;
       i += 2;
       continue;
@@ -533,7 +340,7 @@ var parseClass = (glob2, position) => {
     return ["", false, 0, false];
   }
   if (!ranges.length && !negs.length) {
-    return ["$.", false, glob2.length - pos, true];
+    return ["$.", false, glob.length - pos, true];
   }
   if (negs.length === 0 && ranges.length === 1 && /^\\?.$/.test(ranges[0]) && !negate) {
     const r = ranges[0].length === 2 ? ranges[0].slice(-1) : ranges[0];
@@ -941,16 +748,16 @@ var AST = class {
   toMMPattern() {
     if (this !== this.#root)
       return this.#root.toMMPattern();
-    const glob2 = this.toString();
+    const glob = this.toString();
     const [re, body, hasMagic, uflag] = this.toRegExpSource();
-    const anyMagic = hasMagic || this.#hasMagic || this.#options.nocase && !this.#options.nocaseMagicOnly && glob2.toUpperCase() !== glob2.toLowerCase();
+    const anyMagic = hasMagic || this.#hasMagic || this.#options.nocase && !this.#options.nocaseMagicOnly && glob.toUpperCase() !== glob.toLowerCase();
     if (!anyMagic) {
       return body;
     }
     const flags = (this.#options.nocase ? "i" : "") + (uflag ? "u" : "");
     return Object.assign(new RegExp(`^${re}$`, flags), {
       _src: re,
-      _glob: glob2
+      _glob: glob
     });
   }
   get options() {
@@ -1145,13 +952,13 @@ var AST = class {
       return re;
     }).filter((p) => !(this.isStart() && this.isEnd()) || !!p).join("|");
   }
-  static #parseGlob(glob2, hasMagic, noEmpty = false) {
+  static #parseGlob(glob, hasMagic, noEmpty = false) {
     let escaping = false;
     let re = "";
     let uflag = false;
     let inStar = false;
-    for (let i = 0; i < glob2.length; i++) {
-      const c = glob2.charAt(i);
+    for (let i = 0; i < glob.length; i++) {
+      const c = glob.charAt(i);
       if (escaping) {
         escaping = false;
         re += (reSpecials.has(c) ? "\\" : "") + c;
@@ -1161,14 +968,14 @@ var AST = class {
         if (inStar)
           continue;
         inStar = true;
-        re += noEmpty && /^[*]+$/.test(glob2) ? starNoEmpty : star;
+        re += noEmpty && /^[*]+$/.test(glob) ? starNoEmpty : star;
         hasMagic = true;
         continue;
       } else {
         inStar = false;
       }
       if (c === "\\") {
-        if (i === glob2.length - 1) {
+        if (i === glob.length - 1) {
           re += "\\\\";
         } else {
           escaping = true;
@@ -1176,7 +983,7 @@ var AST = class {
         continue;
       }
       if (c === "[") {
-        const [src, needUflag, consumed, magic] = parseClass(glob2, i);
+        const [src, needUflag, consumed, magic] = parseClass(glob, i);
         if (consumed) {
           re += src;
           uflag = uflag || needUflag;
@@ -1192,7 +999,7 @@ var AST = class {
       }
       re += regExpEscape(c);
     }
-    return [re, unescape(glob2), !!hasMagic, uflag];
+    return [re, unescape(glob), !!hasMagic, uflag];
   }
 };
 _a = AST;
@@ -1264,11 +1071,11 @@ var qmarksTestNoExtDot = ([$0]) => {
   return (f) => f.length === len && f !== "." && f !== "..";
 };
 var defaultPlatform = typeof process === "object" && process ? typeof process.env === "object" && process.env && process.env.__MINIMATCH_TESTING_PLATFORM__ || process.platform : "posix";
-var path3 = {
+var path = {
   win32: { sep: "\\" },
   posix: { sep: "/" }
 };
-var sep = defaultPlatform === "win32" ? path3.win32.sep : path3.posix.sep;
+var sep = defaultPlatform === "win32" ? path.win32.sep : path.posix.sep;
 minimatch.sep = sep;
 var GLOBSTAR = /* @__PURE__ */ Symbol("globstar **");
 minimatch.GLOBSTAR = GLOBSTAR;
@@ -2089,7 +1896,7 @@ function extractFirstParagraph(content) {
 function groupByDirectory(pages) {
   const groups = /* @__PURE__ */ new Map();
   for (const page of pages) {
-    const dir = path4.dirname(page.relativePath);
+    const dir = path2.dirname(page.relativePath);
     const topDir = dir === "." ? "." : dir.split("/")[0];
     if (!groups.has(topDir)) {
       groups.set(topDir, []);
@@ -2130,24 +1937,13 @@ ${cleaned}`);
   return sections.join("\n\n").trimEnd() + "\n";
 }
 
-// src/utils/tokens.ts
-function estimateTokens(content) {
-  return Math.ceil(content.length / 4);
-}
-function formatTokens(count) {
-  if (count >= 1e3) {
-    return `~${(count / 1e3).toFixed(1)}K tokens`;
-  }
-  return `~${count} tokens`;
-}
-
 // src/cli/commands/generate.ts
 async function generateCommand(options = {}) {
   const cwd = process.cwd();
   const config = await loadConfig(cwd);
   const spin = spinner("Scanning documentation...");
   spin.start();
-  const docsDir = path5.resolve(cwd, config.docs.dir);
+  const docsDir = path3.resolve(cwd, config.docs.dir);
   const pages = await scanDocs(docsDir, {
     include: config.docs.include,
     exclude: config.docs.exclude
@@ -2158,7 +1954,7 @@ async function generateCommand(options = {}) {
     return;
   }
   log.info(`Found ${pages.length} documentation pages`);
-  const outputDir = path5.resolve(cwd, config.generate.output_dir);
+  const outputDir = path3.resolve(cwd, config.generate.output_dir);
   if (config.generate.llms_txt && options.only !== "llms-full") {
     const llmsTxt = generateLlmsTxt(pages, {
       title: config.title,
@@ -2170,8 +1966,8 @@ async function generateCommand(options = {}) {
       log.info("[dry-run] Would write llms.txt");
       log.dim(`  ${llmsTxt.length} chars, ${formatTokens(estimateTokens(llmsTxt))}`);
     } else {
-      await fs3.mkdir(outputDir, { recursive: true });
-      await fs3.writeFile(path5.join(outputDir, "llms.txt"), llmsTxt, "utf-8");
+      await fs.mkdir(outputDir, { recursive: true });
+      await fs.writeFile(path3.join(outputDir, "llms.txt"), llmsTxt, "utf-8");
       log.success(`Generated llms.txt (${formatTokens(estimateTokens(llmsTxt))})`);
     }
   }
@@ -2181,8 +1977,8 @@ async function generateCommand(options = {}) {
       log.info("[dry-run] Would write llms-full.txt");
       log.dim(`  ${llmsFullTxt.length} chars, ${formatTokens(estimateTokens(llmsFullTxt))}`);
     } else {
-      await fs3.mkdir(outputDir, { recursive: true });
-      await fs3.writeFile(path5.join(outputDir, "llms-full.txt"), llmsFullTxt, "utf-8");
+      await fs.mkdir(outputDir, { recursive: true });
+      await fs.writeFile(path3.join(outputDir, "llms-full.txt"), llmsFullTxt, "utf-8");
       log.success(`Generated llms-full.txt (${formatTokens(estimateTokens(llmsFullTxt))})`);
     }
   }
@@ -2203,8 +1999,8 @@ async function generateCommand(options = {}) {
       log.info("[dry-run] Would write ai-context.md");
       log.dim(`  ${aiContext.length} chars, ${formatTokens(estimateTokens(aiContext))}`);
     } else {
-      await fs3.mkdir(outputDir, { recursive: true });
-      await fs3.writeFile(path5.join(outputDir, "ai-context.md"), aiContext, "utf-8");
+      await fs.mkdir(outputDir, { recursive: true });
+      await fs.writeFile(path3.join(outputDir, "ai-context.md"), aiContext, "utf-8");
       log.success(`Generated ai-context.md (${formatTokens(estimateTokens(aiContext))})`);
     }
   }
@@ -2212,4 +2008,4 @@ async function generateCommand(options = {}) {
 export {
   generateCommand
 };
-//# sourceMappingURL=generate-LDVEG2WV.js.map
+//# sourceMappingURL=generate-4EHDLBJX.js.map