misspell: support multiple correction words

.golangci.next.reference.yml

@@ -1321,14 +1321,17 @@ linters-settings:
  ignore-words:
  - someword
  # Extra word corrections.
- # `typo` and `correction` should only contain letters.
+ # `typo` should only contain letters.
+ # `correction` can contains one or more words separated by commas without spaces.
  # The words are case-insensitive.
  # Default: []
  extra-words:
  - typo: "iff"
  correction: "if"
  - typo: "cancelation"
  correction: "cancellation"
+ - typo: "successed"
+ correction: "successful,success,succeeded"
  # Mode of the analysis:
  # - default: checks all the file content.
  # - restricted: checks only comments.

pkg/golinters/misspell/misspell.go

@@ -134,7 +134,10 @@ func runMisspellOnFile(lintCtx *linter.Context, filename string, replacer *missp
  var res []result.Issue
 
  for _, diff := range diffs {
- text := fmt.Sprintf("`%s` is a misspelling of `%s`", diff.Original, diff.Corrected)
+ allCorrections := diff.Corrected
+ text := fmt.Sprintf("`%s` is a misspelling of `%s`", diff.Original, allCorrections)
+ // The first suggestion is the most likely to be correct.
+ correction := strings.Split(allCorrections, ",")[0]
 
  pos := token.Position{
  Filename: filename,
@@ -146,7 +149,7 @@ func runMisspellOnFile(lintCtx *linter.Context, filename string, replacer *missp
  Inline: &result.InlineFix{
  StartCol: diff.Column,
  Length: len(diff.Original),
- NewString: diff.Corrected,
+ NewString: correction,
  },
  }
 
@@ -176,7 +179,7 @@ func appendExtraWords(replacer *misspell.Replacer, extraWords []config.MisspellE
  if strings.ContainsFunc(word.Typo, func(r rune) bool { return !unicode.IsLetter(r) }) {
  return fmt.Errorf("the word %q in the 'typo' field should only contain letters", word.Typo)
  }
- if strings.ContainsFunc(word.Correction, func(r rune) bool { return !unicode.IsLetter(r) }) {
+ if strings.ContainsFunc(word.Correction, func(r rune) bool { return r != ',' && !unicode.IsLetter(r) }) {
  return fmt.Errorf("the word %q in the 'correction' field should only contain letters", word.Correction)
  }
 

pkg/golinters/misspell/misspell_test.go

@@ -20,14 +20,18 @@ func Test_appendExtraWords(t *testing.T) {
  Typo: "canCELation",
  Correction: "canceLLaTION",
  },
+ {
+ Typo: "successed",
+ Correction: "successful,success,succeeded",
+ },
  }
 
  replacer := &misspell.Replacer{}
 
  err := appendExtraWords(replacer, extraWords)
  require.NoError(t, err)
 
- expected := []string{"iff", "if", "cancelation", "cancellation"}
+ expected := []string{"iff", "if", "cancelation", "cancellation", "successed", "successful,success,succeeded"}
 
  assert.Equal(t, expected, replacer.Replacements)
 }

pkg/golinters/misspell/testdata/fix/in/misspell.go

@@ -1,4 +1,5 @@
 //golangcitest:args -Emisspell
+//golangcitest:config_path testdata/misspell_fix.yml
 //golangcitest:expected_exitcode 0
 package p
 
@@ -8,6 +9,7 @@ import "log"
 // lala langauge
 // langauge
 // langauge langauge
+// successed
 
 // check Langauge
 // and check langAuge

pkg/golinters/misspell/testdata/fix/out/misspell.go

@@ -1,4 +1,5 @@
 //golangcitest:args -Emisspell
+//golangcitest:config_path testdata/misspell_fix.yml
 //golangcitest:expected_exitcode 0
 package p
 
@@ -8,6 +9,7 @@ import "log"
 // lala language
 // language
 // language language
+// successful
 
 // check Language
 // and check langAuge

pkg/golinters/misspell/testdata/misspell_custom.go

@@ -8,3 +8,4 @@ func Misspell() {
 
 // the word iff should be reported here // want "\\`iff\\` is a misspelling of \\`if\\`"
 // the word cancelation should be reported here // want "\\`cancelation\\` is a misspelling of \\`cancellation\\`"
+// the word successed should be reported here // want "\\`successed\\` is a misspelling of \\`successful,success,succeeded\\`"

pkg/golinters/misspell/testdata/misspell_custom.yml

@@ -5,3 +5,5 @@ linters-settings:
  correction: "if"
  - typo: "cancelation"
  correction: "cancellation"
+ - typo: "successed"
+ correction: "successful,success,succeeded"

pkg/golinters/misspell/testdata/misspell_fix.yml

@@ -0,0 +1,5 @@
+linters-settings:
+ misspell:
+ extra-words:
+ - typo: "successed"
+ correction: "successful,success,succeeded"