lamp/atproto
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
584dea52c4
atproto/packages/lex-cli
History
bnewbold 584dea52c4
tidy up package.json and READMEs () 
* identity: README example and tidy

* tidy up package metadata (package.json files)

* updated README headers/stubs for several packages

* crypto: longer README, with usage

* syntax: tweak README

* Apply suggestions from code review

Co-authored-by: Eric Bailey <git@esb.lol>
Co-authored-by: devin ivy <devinivy@gmail.com>

---------

Co-authored-by: Eric Bailey <git@esb.lol>
Co-authored-by: devin ivy <devinivy@gmail.com>
2023-09-21 18:07:33 -07:00
..
src
@atproto/syntax: merge of @atproto/identifier, uri, and nsid ()
2023-08-25 10:18:10 -05:00
babel.config.js
Unify schemas under lexicon package ()
2022-09-20 18:08:30 -05:00
build.js
pnpm setup ()
2023-09-05 18:45:49 -05:00
CHANGELOG.md
Version packages ()
2023-09-15 15:49:31 -05:00
package.json
tidy up package.json and READMEs ()
2023-09-21 18:07:33 -07:00
README.md
Clean up prettier/eslint scripts ()
2023-09-06 19:27:50 -05:00
tsconfig.build.json
Clean up prettier/eslint scripts ()
2023-09-06 19:27:50 -05:00
tsconfig.json
Clean up prettier/eslint scripts ()
2023-09-06 19:27:50 -05:00

README.md

Lexicon CLI Tool

Command-line tool to generate Lexicon schemas and APIs.

Usage

Usage: lex [options] [command]

Lexicon CLI

Options:
  -V, --version                     output the version number
  -h, --help                        display help for command

Commands:
  new [options] <nsid> [outfile]    Create a new schema json file
  gen-md <schemas...>               Generate markdown documentation
  gen-ts-obj <schemas...>           Generate a TS file that exports an array of schemas
  gen-api <outdir> <schemas...>     Generate a TS client API
  gen-server <outdir> <schemas...>  Generate a TS server API
  help [command]                    display help for command

Example 1: Generate an api

$ lex gen-api ./api/src ./schemas/com/service/*.json ./schemas/com/another/*.json

Example 2: Generate a server

$ lex gen-server ./server/src/xrpc ./schemas/com/service/*.json ./schemas/com/another/*.json

License

MIT