Validate examples #578
Merged
Validate examples #578
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
…plicate example titles and basic syntactic validation. Integrates with Travis-CI to validate examples in specs on commit.
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 adds a Ruby script that extracts examples from the 3 specs (soon 2) and validates them for basic syntactic correctness, and to be sure that example titles are not reused.
The rake task also can be used to extract the examples as individual files into the /examples folder.
Next steps will be to validate that the examples actually produce the results described in neighboring examples, or in some other embedded code. Also, these can be used to automatically create YAML versions of the JSON examples.
As a result, some syntactic problems were identified and corrected.
Tests are run automatically on Travis-CI and can be used as the basis of validating PRs. See https://travis-ci.org/json-ld/json-ld.org/branches for example CI run.