+5

.changeset/modern-cars-throw.md

reviewed

··· 1 1 + --- 2 2 + "prototypey": patch 3 3 + --- 4 4 + 5 5 + documentation update

+10 -12

packages/prototypey/README.md

reviewed

··· 2 2 3 3 A fully-featured sdk for developing lexicons with typescript. 4 4 5 5 + ## Features 6 6 + 7 7 + - atproto spec lexicon authoring with in IDE docs & hints for each attribute (ts => json) 8 8 + - CLI to generate json from ts definitions 9 9 + - CLI to generate ts from json definitions 10 10 + - inference of usage type from full lexicon definition 11 11 + - the really cool part of this is that it fills in the refs from the defs all at the type level 12 12 + - `lx.lexicon(...).validate(data)` for validating data using `@atproto/lexicon` 13 13 + - `fromJSON()` helper for creating lexicons directly from JSON objects with full type inference 14 14 + 5 15 ## Installation 6 16 7 17 ```bash ··· 206 216 ```bash 207 217 npm run lexicon:import 208 218 ``` 209 209 - 210 210 - ## State of the Project 211 211 - 212 212 - **Done:** 213 213 - 214 214 - - Full atproto spec lexicon authoring with in IDE docs & hints for each attribute (ts => json) 215 215 - - CLI generates json from ts definitions 216 216 - - CLI generates ts from json definitions 217 217 - - Inferrance of valid type from full lexicon definition 218 218 - - the really cool part of this is that it fills in the refs from the defs all at the type level 219 219 - - `lx.lexicon(...).validate(data)` for validating data using `@atproto/lexicon` and your lexicon definitions 220 220 - - `fromJSON()` helper for creating lexicons directly from JSON objects with full type inference 221 219 222 220 Please give any and all feedback. I've not really written many lexicons much myself yet, so this project is at a point of "well I think this makes sense". Both the [issues page](https://github.com/tylersayshi/prototypey/issues) and [discussions](https://github.com/tylersayshi/prototypey/discussions) are open and ready for y'all 🙂. 223 221