class RuboCop::RakeTask
Provides a custom rake task.
require ‘rubocop/rake_task’ RuboCop::RakeTask.new
Use global Rake namespace here to avoid namespace issues with custom rubocop-rake tasks
Attributes
fail_on_error[RW]
formatters[RW]
name[RW]
options[RW]
patterns[RW]
requires[RW]
verbose[RW]
Public Class Methods
new(name = :rubocop, *args) { |*[self, task_args].slice(0, arity)| ... }
click to toggle source
Calls superclass method
# File lib/rubocop/rake_task.rb, line 17 def initialize(name = :rubocop, *args, &task_block) super() setup_ivars(name) desc 'Run RuboCop' unless ::Rake.application.last_description task(name, *args) do |_, task_args| RakeFileUtils.verbose(verbose) do yield(*[self, task_args].slice(0, task_block.arity)) if task_block run_cli(verbose, full_options) end end setup_subtasks(name, *args, &task_block) end
Private Instance Methods
full_options()
click to toggle source
# File lib/rubocop/rake_task.rb, line 55 def full_options formatters.map { |f| ['--format', f] }.flatten .concat(requires.map { |r| ['--require', r] }.flatten) .concat(options.flatten) .concat(patterns) end
perform(option)
click to toggle source
# File lib/rubocop/rake_task.rb, line 35 def perform(option) options = full_options.unshift(option) # `parallel` will automatically be removed from the options internally. # This is a nice to have to suppress the warning message # about --parallel and --autocorrect not being compatible. options.delete('--parallel') run_cli(verbose, options) end
run_cli(verbose, options)
click to toggle source
# File lib/rubocop/rake_task.rb, line 44 def run_cli(verbose, options) # We lazy-load RuboCop so that the task doesn't dramatically impact the # load time of your Rakefile. require 'rubocop' cli = CLI.new puts 'Running RuboCop...' if verbose result = cli.run(options) abort('RuboCop failed!') if result.nonzero? && fail_on_error end
setup_ivars(name)
click to toggle source
# File lib/rubocop/rake_task.rb, line 62 def setup_ivars(name) @name = name @verbose = true @fail_on_error = true @patterns = [] @requires = [] @options = [] @formatters = [] end
setup_subtasks(name, *args) { |*[self, task_args].slice(0, arity)| ... }
click to toggle source
# File lib/rubocop/rake_task.rb, line 72 def setup_subtasks(name, *args, &task_block) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength namespace(name) do # rubocop:todo Naming/InclusiveLanguage task(:auto_correct, *args) do require 'rainbow' warn Rainbow( 'rubocop:auto_correct task is deprecated; ' \ 'use rubocop:autocorrect task or rubocop:autocorrect_all task instead.' ).yellow RakeFileUtils.verbose(verbose) do yield(*[self, task_args].slice(0, task_block.arity)) if task_block perform('--autocorrect') end end # rubocop:enable Naming/InclusiveLanguage desc "Autocorrect RuboCop offenses (only when it's safe)." task(:autocorrect, *args) do |_, task_args| RakeFileUtils.verbose(verbose) do yield(*[self, task_args].slice(0, task_block.arity)) if task_block perform('--autocorrect') end end desc 'Autocorrect RuboCop offenses (safe and unsafe).' task(:autocorrect_all, *args) do |_, task_args| RakeFileUtils.verbose(verbose) do yield(*[self, task_args].slice(0, task_block.arity)) if task_block perform('--autocorrect-all') end end end end