Skip to content

Add rubocop to ensure disabling comment aligns with expected format

Doug Stull requested to merge 428762-create-rubocop-disable-format into master

Description of the proposal

Add rubocop to ensure disabling comment aligns with expected format

  • move the check to the left a bit and allow developer to detect the issue quicker before danger.
      # @example RequireColon: true (default)
      #   # bad
      #   # rubocop:disable Some/Cop, Another/Cop
      #
      #   # good
      #   # rubocop:disable Some/Cop, Another/Cop -- Some reason

Refs

Check-list

  • Make sure this MR enables a static analysis check rule for new usage but ignores current offenses.
  • Mention this proposal in the relevant Slack channels (e.g. #development, #backend, #frontend).
  • The MR doesn't have significant objections, and is getting a majority of 👍 vs 👎 (remember that we don't need to reach a consensus).
  • (If applicable) One style is getting a majority of vote (compared to the other choice).
  • (If applicable) Update the MR with the chosen style.
  • Create a follow-up issue to fix the current offenses as a separate iteration: ISSUE_LINK
  • Follow the review process as usual.
  • Once approved and merged by a maintainer, mention it again:
    • In the relevant Slack channels (e.g. #development, #backend, #frontend).
    • (Optional depending on the impact of the change) In the Engineering Week in Review.
Edited by Peter Leitzen

Merge request reports