README.md

Pronto runner for RuboCop

Pronto runner for RuboCop, ruby code analyzer. What is Pronto?

• Configuration
• Usage
• Suggestions
• Only patched lines

Configuration

Configuring RuboCop via .rubocop.yml will work just fine with pronto-rubocop.

You can also specify a custom .rubocop.yml location with the environment variable RUBOCOP_CONFIG.

You can also provide additional configuration via .pronto.yml:

rubocop:
  # Map of RuboCop severity level to Pronto severity level
  severities:
    refactor: info
    warning: error

  # Enable suggestions
  suggestions: true

  # Only report warnings on added/modified lines of code
  # You can provide a number for a range to catch warnings on lines that were not modified
  only_patched_lines:
    enabled: false # default
    range: 0 # default

Suggestions

When suggestions are enabled, the messages will include a line suggesting what to change, using GitHub's syntax on Pull Request reviews, that can be approved in one click right from the Pull Request.

For example:

Only patched lines

When only_patched_lines is enabled, Rubocop warnings that start outside of the patched code will be ignored. For example, if you add a method to a class with too many lines, the warning at the class level will not apply.

This can be useful for legacy applications with a lot of RuboCop warnings, where you want to focus on the new code.

When increasing the range, you will also catch warnings on lines that were not modified but are within the range of the modified lines.

For example, if you set range: 1, you will catch warnings starting before the patched lines, but only if they are within 1 line.

# With `only_patched_lines` enabled and a default range of 1, the Metrics/ClassLength warning is not included in the results.
# However, when `range` is increased to 10, now Metrics/ClassLength will be included alongside the Metrics/MethodLength warning for the `too_long` method.
class TooLong
  def just_fine
    "I'm doing just fine, how about you?"
  end

  def too_long
    # Pretend I am a new method that's 32 lines long.
  end
end