Add CLI package for parsing schema files #1286
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
this is an experiment in defining atjson schemas (specifically annotation definitions) as data instead of as code. by doing so, we can provide some benefits like allowing for clients to download sources and be able to hydrate documents using the atjson libraries without having to install lots of code.
|
cc @blaine I'm interested in hearing some feedback on what sorts of things may be important for this. No worries if you're busy with some other stuff 😄 |
|
A small sample schema may look like: name: rosetta
version: 0.1.0
description: A Rosetta Stone set of annotations used to interoperate between many formats
schema:
bold:
type: mark
description: Emphasizes marked text with a heavier weight font
link:
type: mark
description: Links marked text with a URL
data:
url:
type: string
required: true
paragraph:
type: block
description: A paragraph of text
data:
decorations:
type: enum[]
values: [dropCap, leadIn]
small-caps:
type: mark |
colin-alexa
reviewed
Jul 25, 2022
| @@ -46,10 +47,11 @@ | |||
| "react": "17.0.2", | |||
| "react-dom": "17.0.2", | |||
| "ts-loader": "9.2.8", | |||
| "typescript": "4.6.2", | |||
| "typescript": "^4.8.0-dev.20220628", | |||
colin-alexa
approved these changes
Jul 25, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is an experiment in defining atjson schemas (specifically annotation definitions) as data
instead of as code.
By doing so, we can provide some benefits like allowing for clients to download sources and be able to hydrate documents using the atjson libraries without having to install lots of code.
nb. I'll be providing some concrete examples of why this is a nice thing to have alongside some sample schema definitions. A possible end result of this is a registry of schemas that can be fetched (that is probably overkill though, a simpler solution would probably be better 😄)