[SDQ-2009] Prevent disabling rubocop, except for existing exceptions in the monolith #18
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
marcferna
reviewed
Jul 13, 2023
| Style/DisableCopsWithinSourceCodeDirective: | ||
| Description: Detects comments to enable/disable RuboCop. This is useful if want to make sure that every RuboCop error gets fixed and not quickly disabled with a comment. | ||
| Enabled: true | ||
| AllowedCops: |
There was a problem hiding this comment.
so we are allowing the following cops to be disabled?
There was a problem hiding this comment.
that is correct.
Ideally we'll go through this list, relax/tighten rules as needed, then remove from this list.
There was a problem hiding this comment.
This looks good. Wondering if this list can be moved to https://github.com/sendoso/sendoso/blob/master/.rubocop.yml as this seems specific to that repo.
There was a problem hiding this comment.
This is located here under the assumption that other repos disable the same cops that the monolith, thus keeping this as a central source of truth for rubocop standards.
marcferna
approved these changes
Jul 13, 2023
rhunterharris
deleted the
SDQ-2009-disable-disabling-rubocop-to-enforce-whitelisted-classes-for-missing-super
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Per #17 we want to enforce disabling Lint/MissingSuper, except for certain parent classes. As such, we've added this directive. Following up on #14.
We have whitelisted all rubocop disable types present in the monolith here. This conveniently provides an in-code documentation of directives we need to follow up on and disable or change the rules for.
All monolith rubocop:disable categories are allowlisted here, excluding:
Lint/MissingSuper (https://github.com/sendoso/rubocop-sendoso/pull/17/files)
Rails/SkipsModelValidations (#15)