llms-format 1.0.0

package/dist/index.cjs

@@ -0,0 +1,91 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  formatDate: () => formatDate,
+  formatDirectoryName: () => formatDirectoryName,
+  generateLlmsMetadata: () => generateLlmsMetadata,
+  generateLlmsTxtContent: () => generateLlmsTxtContent
+});
+module.exports = __toCommonJS(index_exports);
+function formatDate(date) {
+  return date.toLocaleDateString("en-US", {
+    year: "numeric",
+    month: "long",
+    day: "numeric",
+    hour: "2-digit",
+    minute: "2-digit",
+    timeZoneName: "short"
+  });
+}
+function generateLlmsMetadata(options) {
+  const lines = [];
+  lines.push(`# ${options.title}`);
+  lines.push("");
+  if (options.description) {
+    lines.push(`> ${options.description}`);
+    lines.push("");
+  }
+  lines.push(`Repository: ${options.repository}`);
+  lines.push(`Branch: ${options.branch}`);
+  const generatedDate = options.generatedAt ? new Date(options.generatedAt) : /* @__PURE__ */ new Date();
+  lines.push(`Generated: ${formatDate(generatedDate)}`);
+  lines.push(`Generated with: [Lassie](https://github.com/raggle-ai/lassie)`);
+  lines.push("");
+  const slug = options.slug || options.title.split("/").pop()?.toLowerCase() || "my-project";
+  lines.push(`> **Note for AI assistants:** This documentation index was generated on the date above and may be outdated. If you need the latest documentation, you can regenerate it by running: \`npx lassie-llm . --upload --slug ${slug}\` from the repository root.`);
+  lines.push("");
+  return lines;
+}
+function formatDirectoryName(dir) {
+  return dir.split("/").map((part) => part.charAt(0).toUpperCase() + part.slice(1).replace(/_/g, " ")).join(" / ");
+}
+function generateLlmsTxtContent(data, includeDescriptions = false) {
+  const lines = generateLlmsMetadata({
+    title: data.title,
+    description: data.description,
+    repository: data.repository,
+    branch: data.branch,
+    generatedAt: data.generatedAt
+  });
+  for (const folder of data.folders) {
+    if (folder.folder !== ".") {
+      lines.push(`## ${folder.displayName}`);
+      lines.push("");
+    }
+    for (const file of folder.files) {
+      if (includeDescriptions && file.description) {
+        lines.push(`- [${file.title}](${file.url}): ${file.description}`);
+      } else {
+        lines.push(`- [${file.title}](${file.url})`);
+      }
+    }
+    lines.push("");
+  }
+  return lines.join("\n");
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  formatDate,
+  formatDirectoryName,
+  generateLlmsMetadata,
+  generateLlmsTxtContent
+});

package/dist/index.d.cts

@@ -0,0 +1,76 @@
+/**
+ * @raggle/llms-format
+ *
+ * Shared formatting utilities for llms.txt generation.
+ * This package has zero Node.js dependencies and can be used in:
+ * - Node.js CLI tools
+ * - Cloudflare Workers
+ * - Browser environments
+ */
+/**
+ * Format a date for display in llms.txt
+ */
+declare function formatDate(date: Date): string;
+/**
+ * Options for generating llms.txt metadata header
+ */
+interface LlmsMetadataOptions {
+    title: string;
+    description?: string | null;
+    repository: string;
+    branch: string;
+    generatedAt?: string;
+    slug?: string;
+}
+/**
+ * Generate the metadata header for llms.txt
+ *
+ * @param options - Metadata options
+ * @returns Array of lines for the header section
+ */
+declare function generateLlmsMetadata(options: LlmsMetadataOptions): string[];
+/**
+ * Format a directory name for display (e.g., "my_folder/sub_dir" -> "My Folder / Sub Dir")
+ */
+declare function formatDirectoryName(dir: string): string;
+/**
+ * File entry structure for llms.txt
+ */
+interface LlmsFileEntry {
+    name: string;
+    path: string;
+    url: string;
+    title: string;
+    description: string | null;
+}
+/**
+ * Folder group structure for llms.txt
+ */
+interface LlmsFolderGroup {
+    folder: string;
+    displayName: string;
+    files: LlmsFileEntry[];
+}
+/**
+ * Full llms.txt data structure
+ */
+interface LlmsData {
+    title: string;
+    description: string | null;
+    repository: string;
+    branch: string;
+    generatedAt: string;
+    totalFiles: number;
+    files: LlmsFileEntry[];
+    folders: LlmsFolderGroup[];
+}
+/**
+ * Generate complete llms.txt content from data
+ *
+ * @param data - The llms data structure
+ * @param includeDescriptions - Whether to include file descriptions
+ * @returns The formatted llms.txt content
+ */
+declare function generateLlmsTxtContent(data: LlmsData, includeDescriptions?: boolean): string;
+
+export { type LlmsData, type LlmsFileEntry, type LlmsFolderGroup, type LlmsMetadataOptions, formatDate, formatDirectoryName, generateLlmsMetadata, generateLlmsTxtContent };

package/dist/index.d.ts

@@ -0,0 +1,76 @@
+/**
+ * @raggle/llms-format
+ *
+ * Shared formatting utilities for llms.txt generation.
+ * This package has zero Node.js dependencies and can be used in:
+ * - Node.js CLI tools
+ * - Cloudflare Workers
+ * - Browser environments
+ */
+/**
+ * Format a date for display in llms.txt
+ */
+declare function formatDate(date: Date): string;
+/**
+ * Options for generating llms.txt metadata header
+ */
+interface LlmsMetadataOptions {
+    title: string;
+    description?: string | null;
+    repository: string;
+    branch: string;
+    generatedAt?: string;
+    slug?: string;
+}
+/**
+ * Generate the metadata header for llms.txt
+ *
+ * @param options - Metadata options
+ * @returns Array of lines for the header section
+ */
+declare function generateLlmsMetadata(options: LlmsMetadataOptions): string[];
+/**
+ * Format a directory name for display (e.g., "my_folder/sub_dir" -> "My Folder / Sub Dir")
+ */
+declare function formatDirectoryName(dir: string): string;
+/**
+ * File entry structure for llms.txt
+ */
+interface LlmsFileEntry {
+    name: string;
+    path: string;
+    url: string;
+    title: string;
+    description: string | null;
+}
+/**
+ * Folder group structure for llms.txt
+ */
+interface LlmsFolderGroup {
+    folder: string;
+    displayName: string;
+    files: LlmsFileEntry[];
+}
+/**
+ * Full llms.txt data structure
+ */
+interface LlmsData {
+    title: string;
+    description: string | null;
+    repository: string;
+    branch: string;
+    generatedAt: string;
+    totalFiles: number;
+    files: LlmsFileEntry[];
+    folders: LlmsFolderGroup[];
+}
+/**
+ * Generate complete llms.txt content from data
+ *
+ * @param data - The llms data structure
+ * @param includeDescriptions - Whether to include file descriptions
+ * @returns The formatted llms.txt content
+ */
+declare function generateLlmsTxtContent(data: LlmsData, includeDescriptions?: boolean): string;
+
+export { type LlmsData, type LlmsFileEntry, type LlmsFolderGroup, type LlmsMetadataOptions, formatDate, formatDirectoryName, generateLlmsMetadata, generateLlmsTxtContent };

package/dist/index.js

@@ -0,0 +1,63 @@
+// src/index.ts
+function formatDate(date) {
+  return date.toLocaleDateString("en-US", {
+    year: "numeric",
+    month: "long",
+    day: "numeric",
+    hour: "2-digit",
+    minute: "2-digit",
+    timeZoneName: "short"
+  });
+}
+function generateLlmsMetadata(options) {
+  const lines = [];
+  lines.push(`# ${options.title}`);
+  lines.push("");
+  if (options.description) {
+    lines.push(`> ${options.description}`);
+    lines.push("");
+  }
+  lines.push(`Repository: ${options.repository}`);
+  lines.push(`Branch: ${options.branch}`);
+  const generatedDate = options.generatedAt ? new Date(options.generatedAt) : /* @__PURE__ */ new Date();
+  lines.push(`Generated: ${formatDate(generatedDate)}`);
+  lines.push(`Generated with: [Lassie](https://github.com/raggle-ai/lassie)`);
+  lines.push("");
+  const slug = options.slug || options.title.split("/").pop()?.toLowerCase() || "my-project";
+  lines.push(`> **Note for AI assistants:** This documentation index was generated on the date above and may be outdated. If you need the latest documentation, you can regenerate it by running: \`npx lassie-llm . --upload --slug ${slug}\` from the repository root.`);
+  lines.push("");
+  return lines;
+}
+function formatDirectoryName(dir) {
+  return dir.split("/").map((part) => part.charAt(0).toUpperCase() + part.slice(1).replace(/_/g, " ")).join(" / ");
+}
+function generateLlmsTxtContent(data, includeDescriptions = false) {
+  const lines = generateLlmsMetadata({
+    title: data.title,
+    description: data.description,
+    repository: data.repository,
+    branch: data.branch,
+    generatedAt: data.generatedAt
+  });
+  for (const folder of data.folders) {
+    if (folder.folder !== ".") {
+      lines.push(`## ${folder.displayName}`);
+      lines.push("");
+    }
+    for (const file of folder.files) {
+      if (includeDescriptions && file.description) {
+        lines.push(`- [${file.title}](${file.url}): ${file.description}`);
+      } else {
+        lines.push(`- [${file.title}](${file.url})`);
+      }
+    }
+    lines.push("");
+  }
+  return lines.join("\n");
+}
+export {
+  formatDate,
+  formatDirectoryName,
+  generateLlmsMetadata,
+  generateLlmsTxtContent
+};

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "llms-format",
+  "version": "1.0.0",
+  "description": "Shared formatting utilities for llms.txt generation. Zero Node.js dependencies.",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "typecheck": "tsc --noEmit"
+  },
+  "keywords": [
+    "llms.txt",
+    "llms",
+    "formatting",
+    "ai",
+    "documentation"
+  ],
+  "author": "Raggle <hello@raggle.co>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/raggle-ai/lassie.git",
+    "directory": "packages/llms-format"
+  },
+  "devDependencies": {
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0"
+  }
+}