Flexicon

ATProto Lexicon Utilities

A couple of premises

1. It's better to express lexicon in CUE, where we can be more expressive. From there we can generate the lexicon docs and much better SDKs for working with them.
2. Do what you want (from Paul's post-ATConf blog post), herein lies a bunch of experiments to inform various discussions in ATProto

Consider this alpha software

This is a new project, here's what the plan is

1. CUE schema for lexicon
   1. Validate according to the spec
   2. Validate based on best practices
2. Generate lexicon json
3. (tbd) generate client/server/sdk in a TS/Go/Py
4. Various existing lexicon and generated content
5. Several popular app's lexicons and content
6. Fork and add your own to reuse these utilities
7. Several extensions to vanilla lexicon
   1. Versioning
   2. Edit History
   3. grafana/thema / schema lenses / Schema negotiation
   4. Module & dependency management
8. SDKs for these extensions
9. CLI wrapping the above

Design Your Lexicon

We'll write up how to design lexicon with our CUE schemas and utilities. For now, poke around the ./design directory.

References

• CUE(lang) is a purpose built language for configuration, schemas, and data
• hof is a code gen tool and more powered by CUE. It already implements some of the more advanced lens like features too!

Dev Setup

Ensure CUE and Docker are installed, as well as language runtimes (go, py, ts). Consider installing https://github.com/hofstadter-io/hof too, we may use it for code gen in the short-term. Long term the Flexicon CLI will handle code gen and much more

# fetch TS deps
pnpm i