Gerador de llms.txt

1// llms-generator.js
2// Pure, framework-agnostic builder for an llms.txt file (Chapter 9).
3// Same function powers the live tool at eduardomendes.com.br/repo/llms-txt.
4//
5// The llms.txt convention (https://llmstxt.org): an H1 name, a blockquote
6// summary, optional free-text notes, then H2 sections of Markdown links that
7// point language models at your canonical, machine-readable pages.
8//
9// Usage:
10//   import { buildLlmsTxt } from "./llms-generator.js";
11//   const text = buildLlmsTxt({ name, description, services, area, contacts, notes });
12
13/**
14 * @param {object} data
15 * @param {string} data.name                 Canonical business/site name (required)
16 * @param {string} data.description          One-line summary (required)
17 * @param {string} [data.siteUrl]            Canonical homepage URL
18 * @param {Array<{title:string,url:string,note?:string}>} [data.services]
19 * @param {string} [data.area]               Coverage area (neighborhoods / cities)
20 * @param {Array<{title:string,url:string}>} [data.contacts]
21 * @param {string} [data.notes]              Guidance for language models
22 * @returns {string} Markdown (llms.txt content)
23 */
24export function buildLlmsTxt(data = {}) {
25  const name = (data.name || "").trim() || "Untitled";
26  const description = (data.description || "").trim();
27  const lines = [];
28
29  lines.push(`# ${name}`);
30  lines.push("");
31  if (description) {
32    lines.push(`> ${description}`);
33    lines.push("");
34  }
35  if (data.siteUrl && data.siteUrl.trim()) {
36    lines.push(`Canonical site: ${data.siteUrl.trim()}`);
37    lines.push("");
38  }
39  if (data.area && data.area.trim()) {
40    lines.push(`Area served: ${data.area.trim()}`);
41    lines.push("");
42  }
43  if (data.notes && data.notes.trim()) {
44    lines.push(data.notes.trim());
45    lines.push("");
46  }
47
48  const services = Array.isArray(data.services)
49    ? data.services.filter((s) => s && s.title && s.title.trim())
50    : [];
51  if (services.length) {
52    lines.push("## Services");
53    for (const s of services) {
54      const note = s.note && s.note.trim() ? `: ${s.note.trim()}` : "";
55      const url = s.url && s.url.trim() ? s.url.trim() : "";
56      lines.push(url ? `- [${s.title.trim()}](${url})${note}` : `- ${s.title.trim()}${note}`);
57    }
58    lines.push("");
59  }
60
61  const contacts = Array.isArray(data.contacts)
62    ? data.contacts.filter((c) => c && c.title && c.title.trim())
63    : [];
64  if (contacts.length) {
65    lines.push("## Contact");
66    for (const c of contacts) {
67      const url = c.url && c.url.trim() ? c.url.trim() : "";
68      lines.push(url ? `- [${c.title.trim()}](${url})` : `- ${c.title.trim()}`);
69    }
70    lines.push("");
71  }
72
73  // Collapse trailing blank lines to a single newline.
74  return lines.join("\n").replace(/\n{3,}/g, "\n\n").replace(/\n+$/, "") + "\n";
75}
76
77export function validate(data = {}) {
78  const errors = {};
79  if (!data.name || !data.name.trim()) errors.name = "required";
80  if (!data.description || !data.description.trim()) errors.description = "required";
81  return errors;
82}