Resolve #36: add -explicit-exhaustive-switch flag #39
Conversation
exhaustive.go
Outdated
| To skip checking of a specific switch statement, associate the comment shown in | ||
| the example below with the switch statement. Note the lack of whitespace between | ||
| the comment marker ("//") and the comment text ("exhaustive:ignore"). | ||
| In implicitly exhaustive switch mode, skip checking of a specific switch |
There was a problem hiding this comment.
Add for clarification in parenthesis:
(-explicit-exhaustive-switch flag off)
Something like:
In implicit checking mode (-explicit-exhaustive-switch flag off), skip checking of ...
--
Here and for the next paragraph.
There was a problem hiding this comment.
I put down "(-explicit-exhaustive-switch=true)" and (-explicit-exhaustive-switch=false)". Does that suffice?
| @@ -212,6 +228,7 @@ func init() { | |||
| // Flag names used by the analyzer. They are exported for use by analyzer | |||
| // driver programs. | |||
| const ( | |||
| ExplicitExhaustiveSwitchFlag = "explicit-exhaustive-switch" | |||
There was a problem hiding this comment.
What do you think of using a shorter name: explicit, and changing the exported constant name to ExplicitFlag?
There was a problem hiding this comment.
That would work. Although it's maybe useful to clarify here between looking at switches as explicitly exhaustive vs e.g. looking at enums as explicitly exhaustive.
// only run exhaustive checks on defined types marked for enforcement
//exhaustive:enforce
type MyEnum int
//exhaustive:enforce
type MyExternalEnumAlias = someexternalpkg.Enum
It's not something currently supported by this analyzer, but maybe it will be one day.
There was a problem hiding this comment.
Thanks, this makes a lot of sense.
switch.go
Outdated
| // Skip checking of this switch statement due to ignore directive comment. | ||
| // Still return true because there may be nested switch statements | ||
| // that are not to be ignored. | ||
| return true, resultSwitchIgnoreComment | ||
| } | ||
| if cfg.explicitExhaustiveSwitch && !containsEnforceDirective(switchComments) { | ||
| // Skip checking of this switch statement due to missing enforce directive comment. | ||
| return true, resultSwitchIgnoreComment |
There was a problem hiding this comment.
Add a new constant for this like resultSwitchMissingEnforceComment instead?
|
Thanks! |
Add
-explicit-exhaustive-switchflag to allow the analyzer to skip exhaustiveness checks on all switches by default unless those switches are associated with an//exhaustive:enforcecomment directive. This should make the analyzer more digestible by teams that rely primarily on non-exhaustive enum switch statements.Also run gofmt on change made to testdata/src/ignore-comment/ignore_comment.go in #38