urfave / cli

A simple, fast, and fun package for building command line apps in Go
https://cli.urfave.org
MIT License
22.31k stars 1.71k forks source link

Fix typo #1995

Open suzuki-shunsuke opened 6 hours ago

suzuki-shunsuke commented 6 hours ago

I checked typo using https://github.com/crate-ci/typos , then a lot of typo are found.

$ git rev-parse HEAD
c4cd0a51cc113a90eca318cc8f7d328f05a5f2b7

$ typos --version
typos-cli 1.26.8
~/repos/src/github.com/urfave/cli main
$ typos
error: `halp` should be `help`
  --> ./docs/v3/examples/generated-help-text.md:80:22
   |
80 |   "args": ["-&#45halp"],
   |                      ^^^^
   |
error: `HALP` should be `HELP`
  --> ./docs/v3/examples/generated-help-text.md:81:24
   |
81 |   "output": "haaaaalp.*HALP"
   |                        ^^^^
   |
error: `halp` should be `help`
  --> ./docs/v3/examples/generated-help-text.md:96:22
   |
96 |   Aliases: []string{"halp"},
   |                      ^^^^
   |
error: `HALP` should be `HELP`
  --> ./docs/v3/examples/generated-help-text.md:97:13
   |
97 |   Usage:   "HALP",
   |             ^^^^
   |
error: `HALP` should be `HELP`
  --> ./docs/v3/examples/generated-help-text.md:98:30
   |
98 |   Sources: cli.EnvVars("SHOW_HALP", "HALPPLZ"),
   |                              ^^^^
   |
error: `halp` should be `help`
  --> ./docs/v3/examples/full-api-example.md:34:38
   |
34 |  cli.HelpFlag = &cli.BoolFlag{Name: "halp"}
   |                                      ^^^^
   |
error: `Thar` should be `Than`, `That`
  --> ./docs/v3/examples/full-api-example.md:165:36
    |
165 |    fmt.Fprintf(cmd.Root().Writer, "Thar be no %q here.\n", command)
    |                                    ^^^^
    |
error: `som` should be `some`
  --> ./docs/v3/examples/combining-short-options.md:20:27
   |
20 |   "args": ["short", "-som", "Some message"],
   |                           ^^^
   |
error: `som` should be `some`
  --> ./docs/v3/examples/combining-short-options.md:69:8
   |
69 | $ cmd -som "Some message"
   |        ^^^
   |
error: `ba` should be `by`, `be`
  --> ./suggestions_test.go:26:11
   |
26 |   {"aa", "ba", 0.6666666666666666},
   |           ^^
   |
error: `ba` should be `by`, `be`
  --> ./suggestions_test.go:27:5
   |
27 |   {"ba", "aa", 0.6666666666666666},
   |     ^^
   |
error: `hel` should be `help`, `hell`, `heal`
  --> ./suggestions_test.go:77:9
   |
77 |   {"", "hel", "--help"},
   |         ^^^
   |
error: `halp` should be `help`
  --> ./docs/v2/examples/generated-help-text.md:79:22
   |
79 |   "args": ["-&#45halp"],
   |                      ^^^^
   |
error: `HALP` should be `HELP`
  --> ./docs/v2/examples/generated-help-text.md:80:24
   |
80 |   "output": "haaaaalp.*HALP"
   |                        ^^^^
   |
error: `halp` should be `help`
  --> ./docs/v2/examples/generated-help-text.md:94:22
   |
94 |   Aliases: []string{"halp"},
   |                      ^^^^
   |
error: `HALP` should be `HELP`
  --> ./docs/v2/examples/generated-help-text.md:95:13
   |
95 |   Usage:   "HALP",
   |             ^^^^
   |
error: `HALP` should be `HELP`
  --> ./docs/v2/examples/generated-help-text.md:96:27
   |
96 |   EnvVars: []string{"SHOW_HALP", "HALPPLZ"},
   |                           ^^^^
   |
error: `halp` should be `help`
  --> ./docs/v2/examples/full-api-example.md:34:38
   |
34 |  cli.HelpFlag = &cli.BoolFlag{Name: "halp"}
   |                                      ^^^^
   |
error: `Thar` should be `Than`, `That`
  --> ./docs/v2/examples/full-api-example.md:172:34
    |
172 |    fmt.Fprintf(cCtx.App.Writer, "Thar be no %q here.\n", command)
    |                                  ^^^^
    |
error: `ser` should be `set`
  --> ./flag_test.go:2190:2
     |
2190 |  ser0 := sl0.Serialize()
     |  ^^^
     |
error: `ser` should be `set`
  --> ./flag_test.go:2192:32
     |
2192 |  require.GreaterOrEqual(t, len(ser0), len(slPfx), "serialized shorter than expected")
     |                                ^^^
     |
error: `ser` should be `set`
  --> ./flag_test.go:2195:14
     |
2195 |  _ = sl1.Set(ser0)
     |              ^^^
     |
error: `ser` should be `set`
  --> ./flag_test.go:2202:2
     |
2202 |  ser0 := sl0.Serialize()
     |  ^^^
     |
error: `ser` should be `set`
  --> ./flag_test.go:2204:32
     |
2204 |  require.GreaterOrEqual(t, len(ser0), len(slPfx), "serialized shorter than expected")
     |                                ^^^
     |
error: `ser` should be `set`
  --> ./flag_test.go:2207:14
     |
2207 |  _ = sl1.Set(ser0)
     |              ^^^
     |
error: `ser` should be `set`
  --> ./flag_test.go:2214:2
     |
2214 |  ser0 := sl0.Serialize()
     |  ^^^
     |
error: `ser` should be `set`
  --> ./flag_test.go:2216:32
     |
2216 |  require.GreaterOrEqual(t, len(ser0), len(slPfx), "serialized shorter than expected")
     |                                ^^^
     |
error: `ser` should be `set`
  --> ./flag_test.go:2219:14
     |
2219 |  _ = sl1.Set(ser0)
     |              ^^^
     |
error: `ser` should be `set`
  --> ./flag_test.go:2226:2
     |
2226 |  ser0 := sl0.Serialize()
     |  ^^^
     |
error: `ser` should be `set`
  --> ./flag_test.go:2228:32
     |
2228 |  require.GreaterOrEqual(t, len(ser0), len(slPfx), "serialized shorter than expected")
     |                                ^^^
     |
error: `ser` should be `set`
  --> ./flag_test.go:2231:14
     |
2231 |  _ = sl1.Set(ser0)
     |              ^^^
     |
error: `ser` should be `set`
  --> ./flag_test.go:2238:2
     |
2238 |  ser0 := m0.Serialize()
     |  ^^^
     |
error: `ser` should be `set`
  --> ./flag_test.go:2240:32
     |
2240 |  require.GreaterOrEqual(t, len(ser0), len(slPfx), "serialized shorter than expected")
     |                                ^^^
     |
error: `ser` should be `set`
  --> ./flag_test.go:2243:13
     |
2243 |  _ = m1.Set(ser0)
     |             ^^^
     |
error: `som` should be `some`
  --> ./docs/v2/examples/combining-short-options.md:20:27
   |
20 |   "args": ["short", "-som", "Some message"],
   |                           ^^^
   |
error: `som` should be `some`
  --> ./docs/v2/examples/combining-short-options.md:68:8
   |
68 | $ cmd -som "Some message"
   |        ^^^
   |
error: `unmarshaling` should be `unmarshalling`
  --> ./docs/CHANGELOG.md:74:32
   |
74 | - Added `Float64SliceFlag` for unmarshaling a list of floats from the user
   |                                ^^^^^^^^^^^^
   |
error: `ist` should be `is`, `it`, `its`, `sit`, `list`
  --> ./docs/v1/examples/flags.md:441:23
    |
441 |     fmt.Println("yaml ist rad")
    |                       ^^^
    |
error: `halp` should be `help`
  --> ./docs/v1/examples/generated-help-text.md:81:22
   |
81 |   "args": ["-&#45halp"],
   |                      ^^^^
   |
error: `HALP` should be `HELP`
  --> ./docs/v1/examples/generated-help-text.md:82:24
   |
82 |   "output": "haaaaalp.*HALP"
   |                        ^^^^
   |
error: `halp` should be `help`
  --> ./docs/v1/examples/generated-help-text.md:96:12
   |
96 |     Name: "halp, haaaaalp",
   |            ^^^^
   |
error: `HALP` should be `HELP`
  --> ./docs/v1/examples/generated-help-text.md:97:13
   |
97 |     Usage: "HALP",
   |             ^^^^
   |
error: `HALP` should be `HELP`
  --> ./docs/v1/examples/generated-help-text.md:98:19
   |
98 |     EnvVar: "SHOW_HALP,HALPPLZ",
   |                   ^^^^
   |
error: `som` should be `some`
  --> ./docs/v1/examples/combining-short-options.md:18:27
   |
18 |   "args": ["short", "-som", "Some message"],
   |                           ^^^
   |
error: `som` should be `some`
  --> ./docs/v1/examples/combining-short-options.md:66:8
   |
66 | $ cmd -som "Some message"
   |        ^^^
   |
error: `halp` should be `help`
  --> ./docs/v1/examples/version-flag.md:109:38
    |
109 |   cli.HelpFlag = cli.BoolFlag{Name: "halp"}
    |                                      ^^^^
    |
error: `pn` should be `on`
  --> ./flag.go:356:2
    |
356 |  pn := prefixedNames(f.Names(), placeholder)
    |  ^^
    |
error: `pn` should be `on`
  --> ./flag.go:359:3
    |
359 |   pn = pn + " [ " + pn + " ]"
    |   ^^
    |
error: `pn` should be `on`
  --> ./flag.go:359:8
    |
359 |   pn = pn + " [ " + pn + " ]"
    |        ^^
    |
error: `pn` should be `on`
  --> ./flag.go:359:21
    |
359 |   pn = pn + " [ " + pn + " ]"
    |                     ^^
    |
error: `pn` should be `on`
  --> ./flag.go:362:60
    |
362 |  return withEnvHint(df.GetEnvVars(), fmt.Sprintf("%s\t%s", pn, usageWithDefault))
    |                                                            ^^
    |
error: `Thar` should be `Than`, `That`
  --> ./docs/v1/examples/version-flag.md:249:32
    |
249 |     fmt.Fprintf(c.App.Writer, "Thar be no %q here.\n", command)
    |                                ^^^^
    |
error: `trigerred` should be `triggered`
  --> ./command_test.go:3056:66
     |
3056 |  assert.True(t, cmd1 == 1 && cmd2 == 0, "Expected command1 to be trigerred once")
     |                                                                  ^^^^^^^^^
     |
error: `trigerred` should be `triggered`
  --> ./command_test.go:3063:66
     |
3063 |  assert.True(t, cmd1 == 1 && cmd2 == 0, "Expected command1 to be trigerred once")
     |                                                                  ^^^^^^^^^
     |
error: `trigerred` should be `triggered`
  --> ./command_test.go:3070:66
     |
3070 |  assert.True(t, cmd1 == 1 && cmd2 == 0, "Expected command1 to be trigerred once")
     |                                                                  ^^^^^^^^^
     |
error: `trigerred` should be `triggered`
  --> ./command_test.go:3077:66
     |
3077 |  assert.True(t, cmd1 == 0 && cmd2 == 1, "Expected command1 to be trigerred once")
     |                                                                  ^^^^^^^^^
     |
error: `trigerred` should be `triggered`
  --> ./command_test.go:3084:66
     |
3084 |  assert.True(t, cmd1 == 0 && cmd2 == 1, "Expected command1 to be trigerred once")
     |                                                                  ^^^^^^^^^
     |
suzuki-shunsuke commented 4 hours ago