Merge pull request #97 from aspiers/gen-schemas

auto-generate lexicon schema Markdown tables

Author: s-adamantine

.changeset/move-schema-docs-to-autogenerated-file.md

@@ -0,0 +1,5 @@
+---
+"@hypercerts-org/lexicon": minor
+---
+
+Move schema documentation tables from README.md to auto-generated SCHEMAS.md to reduce git merge conflicts. The SCHEMAS.md file is now auto-generated from lexicon definitions and included in the distributed package.

.gitattributes

@@ -0,0 +1,3 @@
+# Custom merge driver for auto-generated files
+# When SCHEMAS.md has conflicts, regenerate it and use the result
+SCHEMAS.md merge=schemas

.gitignore

@@ -4,3 +4,4 @@ dist/
 generated/
 pnpm-lock.yaml
 /tmp/
+lexicons.md

AGENTS.md

@@ -58,6 +58,8 @@ and type declaration files in `dist/`.
 
 ## Development Commands
 
+**⚠️ IMPORTANT FOR AI AGENTS**: Always run scripts through npm scripts (e.g., `npm run gen-schemas-md`) rather than executing Node.js files directly (e.g., `node scripts/generate-schemas.js`). This ensures proper environment setup and consistency with the project's workflow.
+
 ### Code Generation
 
 ```bash
@@ -70,6 +72,9 @@ npm run gen-index
 # Build distributable bundles
 npm run build
 
+# Generate SCHEMAS.md from lexicon definitions
+npm run gen-schemas-md
+
 # Generate markdown documentation from lexicons
 npm run gen-md
 
@@ -205,6 +210,7 @@ lexicons/               # Source of truth (committed)
 scripts/                # Build scripts (committed)
   create-shims.sh       # Generate type shims for external lexicons
   generate-exports.js   # Auto-generate generated/exports.ts
+  generate-schemas.js   # Auto-generate SCHEMAS.md from lexicons
 
 generated/              # Auto-generated (gitignored)
   index.ts              # Generated client (not exposed)