Add a script to generate llms.txt (#2004)

Author: amandeepmittal

.gitignore

@@ -25,3 +25,6 @@ out/
 
 # TS build files
 tsconfig.tsbuildinfo
+
+# llms.txt
+public/llms.txt

package.json

@@ -3,7 +3,7 @@
   "private": true,
   "scripts": {
     "start": "next dev --webpack",
-    "build": "bun data:update && next build --webpack",
+    "build": "bun data:update && bun llms:generate && next build --webpack",
     "preview": "next build --webpack && next start",
     "lint": "eslint .",
     "data:update": "bun scripts/build-and-score-data",
@@ -13,6 +13,7 @@
     "libraries:recalculate": "bun scripts/recalculate-scores",
     "libraries:format": "prettier --experimental-cli --write react-native-libraries.json",
     "libraries:check": "bun scripts/check-resources",
+    "llms:generate": "bun scripts/generate-llms",
     "ci:cleanup-blobs": "bun scripts/cleanup-data-blobs",
     "ci:validate": "bun scripts/validate-new-entries",
     "precommit": "simple-git-hooks && lint-staged"

scripts/generate-llms.ts

@@ -0,0 +1,128 @@
+import fs from 'node:fs/promises';
+import path from 'node:path';
+
+import { FILTER_COMPATIBILITY, FILTER_PLATFORMS } from '~/components/Filters/helpers';
+import { type DataAssetType, type LibraryType } from '~/types';
+import { getNewArchSupportStatus, NewArchSupportStatus } from '~/util/newArchStatus';
+
+const OUTPUT_PATH = path.resolve('public', 'llms.txt');
+const DATASET_PATH = path.resolve('assets', 'data.json');
+const INTRODUCTION = [
+  '# reactnative.directory',
+  'Browse the full catalog at https://reactnative.directory for fresh React Native libraries.',
+];
+
+const SUPPORTED_FILTERS = [...FILTER_PLATFORMS, ...FILTER_COMPATIBILITY];
+const NEW_ARCHITECTURE_STATUS_LABELS: Record<NewArchSupportStatus, string> = {
+  [NewArchSupportStatus.NewArchOnly]: 'Only Supports New Architecture',
+  [NewArchSupportStatus.Supported]: 'Supports New Architecture',
+  [NewArchSupportStatus.Unsupported]: 'Does not support New Architecture',
+  [NewArchSupportStatus.Untested]: 'Untested with New Architecture',
+};
+
+function formatRecord(library: LibraryType, repoUrl: string, rawDescription: string): string {
+  const displayName = library.npmPkg;
+  const platforms = getSupportedPlatforms(library);
+  const supportText = platforms.length ? platforms.join(', ') : 'Not specified';
+  const header = `[${displayName}](${repoUrl}): ${rawDescription}`;
+  const newArchStatus = getNewArchSupportStatus(library);
+  const newArch = formatNewArchitectureStatus(newArchStatus, library.newArchitectureNote);
+  const downloads = formatDownloads(library);
+  const website = library.github?.urls.homepage;
+  const latestVersion = library.npm?.latestRelease;
+  const latestReleaseDate = library.npm?.latestReleaseDate;
+  const lines = [`${header}`, `Supports: ${supportText}`, `New Architecture: ${newArch}`];
+  if (downloads) {
+    lines.push(`Downloads: ${downloads}`);
+  }
+  if (website) {
+    lines.push(`Website: ${website}`);
+  }
+  if (latestVersion) {
+    lines.push(`Latest Version: ${latestVersion}`);
+  }
+  if (latestReleaseDate) {
+    const date = new Date(latestReleaseDate).toISOString().split('T')[0];
+    lines.push(`Latest Release Date: ${date}`);
+  }
+  return lines.join('\n');
+}
+
+function getSupportedPlatforms(library: LibraryType) {
+  const platforms: string[] = [];
+  SUPPORTED_FILTERS.forEach(filter => {
+    const key = filter.param as keyof LibraryType;
+    const value = library[key];
+    const title = filter.title;
+
+    if (typeof value === 'boolean' && value) {
+      platforms.push(title);
+      return;
+    }
+
+    if (typeof value === 'string' && value) {
+      platforms.push(`${title} (${value})`);
+    }
+  });
+  return platforms;
+}
+
+function formatNewArchitectureStatus(status: NewArchSupportStatus, note?: string) {
+  const value = NEW_ARCHITECTURE_STATUS_LABELS[status];
+
+  if (note) {
+    return `${value} (${note})`;
+  }
+  return value;
+}
+
+function formatDownloads(library: LibraryType) {
+  const downloads = library.npm?.downloads;
+  const weekDownloads = library.npm?.weekDownloads;
+
+  if (!downloads && !weekDownloads) {
+    return null;
+  }
+
+  const parts: string[] = [];
+
+  if (typeof downloads === 'number' && downloads > 0) {
+    parts.push(`${downloads} total`);
+  }
+
+  if (typeof weekDownloads === 'number' && weekDownloads > 0) {
+    parts.push(`${weekDownloads} last week`);
+  }
+
+  return parts.join(', ');
+}
+
+async function generateLlmsFile() {
+  const assetLibraries = await loadAssetLibraries();
+  const entries = assetLibraries
+    .filter(library => !library.template)
+    .map(library => formatRecord(library, library.githubUrl, library.github?.description ?? ''));
+
+  const content = [...INTRODUCTION, ...entries].join('\n\n---\n\n');
+
+  await fs.writeFile(OUTPUT_PATH, `${content}\n`, 'utf8');
+  console.log(
+    `Generated ${entries.length} entries in ${path.relative(process.cwd(), OUTPUT_PATH)}`
+  );
+}
+
+async function loadAssetLibraries(): Promise<DataAssetType['libraries']> {
+  try {
+    const raw = await fs.readFile(DATASET_PATH, 'utf8');
+    const parsed = JSON.parse(raw) as DataAssetType;
+    return parsed.libraries ?? [];
+  } catch (error) {
+    console.warn(
+      'Unable to read cached assets/data.json. Continuing without cached descriptions.',
+      error
+    );
+    return [];
+  }
+}
+
+await generateLlmsFile();