Generalize JSON schema handling code #14
Merged
Conversation
This file contains hidden or 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
Previously, the JSON schema handling code was all under the libraryproperties package, and written specifically for use in validating library.properties against the JSON schema. However, there will be be a need to work with schemas in other contexts, most immediately for writitng the schema tests, but also likely when additional schemas are added for the other Arduino project configuration data files. So it will be helpful to have the general purpose schema handling code in a dedicated package, leaving only the library.properties-specific aspects of the code in the libraryproperties package.
silvanocerza
reviewed
Nov 4, 2020
silvanocerza
reviewed
Nov 4, 2020
silvanocerza
reviewed
Nov 4, 2020
silvanocerza
suggested changes
Nov 4, 2020
This allows the schemas path to be specified by the caller.
Rather than determining the schemas path once at initialization and storing it in a package variable, determine it on demand when the getter function is called.
I don't foresee any need for this function outside the `schema` package, so it doesn't seem necessary to export it.
|
I have pushed another commit to move It turns out that I am still going to need to convert the schema file path to URI even after switching to the new JSON schema validation package. I don't foresee any need for this function outside the |
silvanocerza
approved these changes
Nov 5, 2020
per1234
added
topic: code
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.
Previously, the JSON schema handling code was all under the
librarypropertiespackage, and written specifically for usein validating library.properties against the JSON schema. However, there will be be a need to work with schemas in other
contexts, most immediately for writing the schema tests, but also likely when additional schemas are added for the
other Arduino project configuration data files.
So it will be helpful to have the general purpose schema handling code
in a dedicated package, leaving only the library.properties-specific aspects of the code in the
librarypropertiespackage.
NOTE: the next PR will change to a different JSON schema package, which will involve changing almost all of the code in the
schemapackage, as well as its API and removing theutilpackage. So this PR is mostly just about moving the schema handling code to a dedicated package, as doing that in combination with the package change would not be atomic. I don't think it's necessary to spend a lot of time on a detailed analysis of the doomed code itself (which is mostly just being moved from one package to another anyway.