feat: validate bookmark files #42
Merged
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
frederikb
force-pushed
the
feature/bookmark-file-validation
branch
2 times, most recently
from
0c1fb0d
to
0e9dd78
Compare
The JSON structure supported by this extension was never explictly documented and only explained by examples. Due to upcoming features and knowing how manipulating (deeply) nested JSON by hand is error-prone it makes sense to perform validation before attempting to import the bookmark files. I defined a JSON schema and additionally published it to a public location. JSON Schema for Bookmarks: https://frederikb.github.io/bookmarksync/schemas/bookmarks.1-0-0.schema.json In the (rare) case that the schema is updated we need to ensure that the new version is published as well. The schema is versioned according to SchemaVer. As a side benefit, users may also reference the schema in their bookmark JSON files, via a $schema entry on the root and gain immediate validation in their editor (if supported). Fixes #29
frederikb
force-pushed
the
feature/bookmark-file-validation
branch
from
0e9dd78
to
f5c1e56
Compare
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.
The JSON structure supported by this extension was never explictly documented and only explained by examples. Due to upcoming features and knowing how manipulating (deeply) nested JSON by hand is error-prone it makes sense to perform validation before attempting to import the bookmark files.
I defined a JSON schema and additionally published it to a public location. JSON Schema for Bookmarks:
https://frederikb.github.io/bookmarksync/schemas/bookmarks.1-0-0.schema.json In the (rare) case that the schema is updated we need to ensure that the new version is published as well.
The schema is versioned according to SchemaVer.
As a side benefit, users may also reference the schema in their bookmark JSON files, via a $schema entry on the root and gain immediate validation in their editor (if supported).
Fixes #29