Faster runs via RuboCop::Runner #573
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
I'd moved this to a class-level instance variable back in bd82186, but only to avoid issues with Marshal.dump on the linter instance. Instead, let's override marshal_dump to exclude the problematic ivars
Every time we call RuboCop::CLI#run (which happens once per file being linted), it sets up a new RuboCop::Runner. This is pretty slow, especially from RuboCop::Options#parse and RuboCop::Runner#mobilized_cop_classes. We can skip all this repeated setup by using RuboCop::Runner directly. This also means we don't have to capture the stdout/stderr streams from CLI, since the relevant information is available directly on the runner instance.
If we're not using RuboCop::CLI, I think we may as well collect the offenses in the runner directly
|
I've also got a POC here that makes use of RuboCop's cache, which dramatically improves times on already-processed files: RuboCop doesn't use its cache on code from stdin, so when we generate ruby code from the haml file for RuboCop to lint, we could write it to, eg, |
4af1355 to
c86999d
Compare
c86999d to
6f9c84e
Compare
|
Amazing work! Thank you |
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.
Every time we call
RuboCop::CLI#run(which happens once per file being linted), it sets up a new RuboCop::Runner.This is pretty slow, especially from
RuboCop::Options#parseandRuboCop::Runner#mobilized_cop_classes.We can skip all this repeated setup by using RuboCop::Runner directly. This also means we don't have to capture the stdout/stderr streams from CLI, since the relevant information is available directly on the runner instance.
Before:
After:
I've introduced a subclass of RuboCop::Runner to handle some of the customizations we need. ruby-lsp have a similar approach here - https://github.com/Shopify/ruby-lsp/blob/13bb8b0addf96248a951dca988e40127c86b6ba8/lib/ruby_lsp/requests/support/rubocop_runner.rb#L54, which might be useful for comparison.