[Fix #10515] Add --json-schema generator #12323
Open
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.
Per #10515, adds a
--json-schema
flag to output a JSON Schema for your project's RuboCop configuration file.This allows your IDE to autocomplete/validate the cop, department and global settings in your
.rubocop.yml
, including those of any extensions you've added viarequire
.Next Steps
There are examples for vscode and intellij in the docs, but it's still sort of DIY to get this set up.
What we want to do next is register it in the JSON Schema Store so that editors pick it up automatically.
For that we need a permanent URL where the schema can live. I added some code to generate a schema in the
assets
dir that includes rules for most of the extensions listed in the documentation. The URL in this case would be something like this:https://raw.githubusercontent.com/rubocop/rubocop/master/assets/schema.json
If we like this approach I can commit the generated schema as part of this PR and open a PR at the schema store repo.
Alternatively we could host it with the docs or in a separate repo or something. In any case we'll probably want to incorporate schema generation into the build or release process so it stays current as cops are added/removed.
Notes
Before submitting the PR make sure the following are checked:
[Fix #issue-number]
(if the related issue exists).master
(if not - rebase it).bundle exec rake default
. It executes all tests and runs RuboCop on its own code.{change_type}_{change_description}.md
if the new code introduces user-observable changes. See changelog entry format for details.