feature: new rule enforce-switch-default #1390
Merged
Conversation
This file contains hidden or 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
|
This is also available https://go-critic.com/overview.html#defaultcaseorder I feel like adding an option to go-critic to enforce the last position should be preferred |
alexandear
reviewed
May 29, 2025
alexandear
reviewed
May 29, 2025
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new rule, enforce-switch-default, that validates the presence and the position of default clauses in switch statements, with configurable options.
- Added test files demonstrating various switch clause configurations.
- Implemented the enforce-switch-default rule and integrated it into the core rules and documentation.
- Updated RULES_DESCRIPTIONS.md and README.md with the new rule's details.
Reviewed Changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| testdata/enforce_switch_default_allow_not_last.go | Test cases for allowing default clauses to appear in non-final positions. |
| testdata/enforce_switch_default_allow_no_default.go | Test cases for allowing switch statements without a default clause. |
| testdata/enforce_switch_default.go | Test cases for enforcing both the presence and last-position of the default clause. |
| test/enforce_switch_default_test.go | Automated tests validating the new rule under various configurations. |
| rule/enforce_switch_default.go | Implementation of the enforce-switch-default rule. |
| config/config.go | Registration of the new rule in the configuration. |
| RULES_DESCRIPTIONS.md | Documentation update for the new rule. |
| README.md | Updated rule summary table in the README. |
alexandear
reviewed
May 29, 2025
alexandear
approved these changes
May 31, 2025
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.
Inspired by this remark this PR adds a new rule to enforce
defaultinswitch.The rule, by default, enforces:
default, anddefaultBoth checks can be deactivated independently through configuration.
Notes:
1, Yes, there is another linter that does something similar but: a) the implementation feels awkward to me; b) it doesn't checks
defaultposition.2. Yes, something similar could be done for
selectbut IMO it is better to provide 2 different rules because.... TL;TW rule simplicity and ease of use.