Skip to content

Commit

Permalink
godot: add period option (#2483)
Browse files Browse the repository at this point in the history
  • Loading branch information
butuzov committed Jan 15, 2022
1 parent cf053b2 commit 95b9b23
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 8 deletions.
15 changes: 9 additions & 6 deletions .golangci.example.yml
Expand Up @@ -343,14 +343,17 @@ linters-settings:
min-complexity: 10

godot:
# comments to be checked: `declarations`, `toplevel`, or `all`
scope: declarations
# comments to be checked: `declarations`, `toplevel`, or `all` (default: declarations)
scope: toplevel
# list of regexps for excluding particular comment lines from check
exclude:
# example: exclude comments which contain numbers
# - '[0-9]+'
# check that each sentence starts with a capital letter
capital: false
# exclude todo and fixme comments
- "^fixme:"
- "^todo:"
# check that each sentence ends with a period (default: true)
period: false
# check that each sentence starts with a capital letter (default: false)
capital: true

godox:
# report any comments starting with keywords, this is useful for TODO or FIXME comments that
Expand Down
5 changes: 5 additions & 0 deletions pkg/config/linters_settings.go
Expand Up @@ -35,6 +35,10 @@ var defaultLintersSettings = LintersSettings{
Godox: GodoxSettings{
Keywords: []string{},
},
Godot: GodotSettings{
Scope: "declarations",
Period: true,
},
Gofumpt: GofumptSettings{
LangVersion: "",
ExtraRules: false,
Expand Down Expand Up @@ -266,6 +270,7 @@ type GodotSettings struct {
Scope string `mapstructure:"scope"`
Exclude []string `mapstructure:"exclude"`
Capital bool `mapstructure:"capital"`
Period bool `mapstructure:"period"`

// Deprecated: use `Scope` instead
CheckAll bool `mapstructure:"check-all"`
Expand Down
5 changes: 3 additions & 2 deletions pkg/golinters/godot.go
Expand Up @@ -31,13 +31,14 @@ func NewGodot() *goanalysis.Linter {
settings := godot.Settings{
Scope: godot.Scope(cfg.Scope),
Exclude: cfg.Exclude,
Period: true,
Period: cfg.Period,
Capital: cfg.Capital,
}

// Convert deprecated setting
// todo(butuzov): remove on v2 release
if cfg.CheckAll { // nolint:staticcheck
settings.Scope = godot.TopLevelScope
settings.Scope = godot.AllScope
}

if settings.Scope == "" {
Expand Down

0 comments on commit 95b9b23

Please sign in to comment.