rubocop-daemon
rubocop-daemon
makes RuboCop faster.
Installation
Install rubocop-daemon
via rubygems.org:
gem install rubocop-daemon
Usage
To start the server, just run:
rubocop-daemon start
Then you can execute RuboCop fast:
rubocop-daemon exec
And you can pass files:
rubocop-daemon exec foo.rb bar.rb
If you want to pass arguments to RuboCop, you should separate arguments by --
:
rubocop-daemon exec -- --auto-correct
Commands
You can control the server like this:
rubocop-daemon <command>
Available commands:
start
: start the serverstop
: stop the serverstatus
: print out whether the server is currently runningrestart
: restart the serverexec [file1, file2, ...] [-- [rubocop-options]]
: invokerubocop
with the givenrubocop-options
More speed
rubocop-daemon-wrapper
is a bash script that talks to the rubocop-daemon
server via netcat
. This provides much lower latency than the rubocop-daemon
Ruby script.
For now, you have to manually download and install the bash script:
(
rubygems
will wrap any executable files with a Ruby script, and you can't disable this behavior.)
curl https://raw.githubusercontent.com/fohte/rubocop-daemon/master/bin/rubocop-daemon-wrapper -o /tmp/rubocop-daemon-wrapper
sudo mv /tmp/rubocop-daemon-wrapper /usr/local/bin/rubocop-daemon-wrapper
sudo chmod +x /usr/local/bin/rubocop-daemon-wrapper
You can then replace any calls to rubocop
with rubocop-daemon-wrapper
.
rubocop-daemon-wrapper foo.rb bar.rb
rubocop-daemon-wrapper
will automatically start the daemon server if it is not already running. So the first call will be about the same as rubocop
, but the second call will be much faster.
Use with VS Code
Unfortunately, the vscode-ruby extension doesn't really allow you to customize the rubocop
path or binary. (You can change the linter path, but not the formatter.)
In the meantime, you could just override the rubocop
binary with a symlink to rubocop-daemon-wrapper
:
# Find your rubocop path
$ which rubocop
# => /Users/username/.rvm/gems/ruby-2.5.3/bin/rubocop
# Override rubocop with a symlink to rubocop-daemon-wrapper
$ ln -fs /usr/local/bin/rubocop-daemon-wrapper /Users/username/.rvm/gems/ruby-2.5.3/bin/rubocop
Now VS Code will use the rubocop-daemon-wrapper
script, and formatOnSave
should be much faster (~150ms instead of 3-5 seconds).
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/fohte/rubocop-daemon.
License
The gem is available as open source under the terms of the MIT License.