Skip to content

Resolve auto-correctable RuboCop offenses (Exclude-only) in .rubocop_todo/**/*.yml

❗ COMMUNITY CONTRIBUTORS, PLEASE ONLY PICKUP ONE COP VIOLATION TO ALLOW OTHER NEW CONTRIBUTORS TO LEARN FROM THESE TOO ❗

Problem

.rubocop_todo/**/*.yml contains auto-correctable (RuboCop) offenses (grep -hr auto-correct .rubocop_todo -A 1 | grep "^[A-Z]") which can be fixed automatically.

Implementation guide

Resolve auto-correctable rules which are enabled by letting RuboCop auto-correct them automatically 🎉

  1. Verify that the you are working on is already enabled. See also #369268 (closed)
  2. Pick a offense from The List below e.g. Layout/ClosingHeredocIndentation
  3. Create a branch (e.g. 239356-fix-Layout/ClosingHeredocIndentation)
    • Info: Using this issue ID (239356) in a branch name will add required labels and reference to this issue in the new merge request.
  4. Delete the rule from the corresponding .rubocop_todo/ YAML file (for example https://gitlab.com/gitlab-org/gitlab/-/blob/fdeea9247566ca45fece68605a838ebc659b62db/.rubocop_todo/gitlab/rails/safe_format.yml)
  5. Auto-correct RuboCop offenses via e.g. bundle exec rubocop --autocorrect --only Layout/ClosingHeredocIndentation
  6. Check changed files and adjust if needed
    • Suggestion: In order to keep MRs short one can fix 10-15 files in one go. Depending on the amount of changes in the file.
  7. Commit and create a merge request
  8. Mention this merge request in this issue
  9. 🎉

The List

📣 A list containing all auto-correctable offenses

How to regenerate the list?

  1. Copy+paste the Script from below 👇 as save as regenerate.rb
  2. Copy+paste the The List from above ☝️ and save as old_list.txt
  3. Run regenerate.rb < old_list.txt > new_list.txt
  4. Replace the new list in the The List section

Script

script 
#!/usr/bin/env ruby
# frozen_string_literal: true

# From https://gitlab.com/gitlab-org/gitlab/-/issues/239356#the-list

require "yaml"

sha = `git rev-parse HEAD`.chomp

template = <<~MD
- [ ] [`%{rule_name}`](https://gitlab.com/gitlab-org/gitlab/-/blob/#{sha}/%{path}) (%{entries} entries)
MD

warn "Paste the markdown bullet point list from https://gitlab.com/gitlab-org/gitlab/-/issues/239356:"
current = $stdin.readlines.to_h { |line| [line[/`(\S+)`/, 1], line] }

todos = Dir.glob(".rubocop_todo/**/*.yml").to_h do |path|
  next [nil, []] unless /^# Cop supports --auto-?correct/.match?(File.read(path))

  yaml = YAML.safe_load_file(path)
  name, config = yaml.first
  entries = config.fetch('Exclude', []) || []
  [name, [path, entries.size]]
end

todos.delete(nil)

(current.keys | todos.keys).uniq.sort.each do |name|
  path, entries = todos[name]
  current_line = current[name]

  if current_line && !path
    current_line.sub!('- [ ]', '- [x]') 
    current_line.sub!(/\d+ entries/, '0 entries')
    puts current_line
  elsif path
    puts format(template, rule_name: name, path: path, entries: entries)
  end
end
Edited by Vitali Tatarintev