chore(ci): add cspell spellcheck linting

I type a little too fast sometimes and make a lot of mistakes. Add
cspell to make fewer of them.

Author: brandon1024

.cspell.json

@@ -0,0 +1,14 @@
+{
+  "version": "0.2",
+  "language": "en",
+  "dictionaries": [
+    "go",
+    "softwareTerms"
+  ],
+  "words": [
+    "cmder",
+    "getopt",
+    "untar",
+    "hexdump"
+  ]
+}

.github/workflows/go.yml

@@ -11,14 +11,25 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
+    - uses: actions/checkout@v5
+      with:
+        persist-credentials: false
     - name: Set up Go
       uses: actions/setup-go@v4
       with:
         go-version: stable
     - name: Test
       run: make test
-    - name: golangci-lint
+    - name: Lint
       uses: golangci/golangci-lint-action@v9
       with:
         version: v2.9
+    - name: Spelling
+      uses: streetsidesoftware/cspell-action@v8
+      continue-on-error: true
+      with:
+        files: |
+          **/*.go
+          README.md
+        incremental_files_only: false
+        suggestions: true

README.md

@@ -16,14 +16,14 @@ less is better. The wide range of examples throughout the project should help
 you get started.
 
 To define a new command, simply define a type that implements the `Command`
-interface. If you want your command to have additional behaviour like flags or
+interface. If you want your command to have additional behavior like flags or
 subcommands, simply implement the appropriate interfaces.
 
 Here are some highlights:
 
-- Bring your own types. `cmder` doens't force you to use special `command`
+- Bring your own types. `cmder` doesn't force you to use special `command`
   structs. As long as you implement our narrow interfaces, you're good to go!
-- `cmder` is unobtrustive. Define your command and execute it. Simplicity above
+- `cmder` is unobtrusive. Define your command and execute it. Simplicity above
   all else!
 - `cmder` is totally stateless making it super easy to unit test your commands.
   This isn't the case in other libraries.
@@ -88,7 +88,7 @@ func main() {
 For more complex commands, you can define your own command type. By embedding
 `cmder.BaseCommand`, your command automatically implements all of the important
 interfaces needed to document your command, define flags, register subcommands,
-and so on. You can then override the default behaviour with your own.
+and so on. You can then override the default behavior with your own.
 
 ```go
 package main

command.go

@@ -8,8 +8,8 @@ import (
 // Command is the fundamental interface implemented by types that are runnable commands or subcommands. Commands can
 // be executed with [Execute].
 //
-// Concrete types can implement additional interfaces to configure additional behaviour, like setup/teardown routines,
-// subcommands, command-line flags, and other behaviour:
+// Concrete types can implement additional interfaces to configure additional behavior, like setup/teardown routines,
+// subcommands, command-line flags, and other behavior:
 //
 //   - If you want to configure setup and teardown routines for a command, see [Initializer] and [Destroyer].
 //   - If your command has subcommands, see [RootCommand].
@@ -79,7 +79,7 @@ type Documented interface {
 	//
 	// Here are a few examples:
 	//
-	//	git add [<options>] [--] <pathspec>...
+	//	git add [<options>] [--] <path spec>...
 	//	kubectl get [(-o|--output=)json|yaml|wide] (TYPE[.VERSION][.GROUP] [NAME | -l label] | TYPE[.VERSION][.GROUP]/NAME ...) [flags] [options]
 	//	crane index filter [flags]
 	UsageLine() string
@@ -95,7 +95,7 @@ type Documented interface {
 	ShortHelpText() string
 
 	// HelpText returns longer usage and help information for your users about this subcommand. Here you can describe
-	// the behaviour of your command, summarize usage of certain flags and arguments and provide hints on where to find
+	// the behavior of your command, summarize usage of certain flags and arguments and provide hints on where to find
 	// additional information. This is akin to the "DESCRIPTION" section you would typically find in a man page.
 	//
 	// For a better viewing experience in terminals, consider maintaining consistent line length limits (120 is a good
@@ -124,7 +124,7 @@ var (
 	_ HiddenCommand   = &CommandDocumentation{}
 )
 
-// CommandDocumentation implements [Documented] and can be embdded in command types to reduce boilerplate.
+// CommandDocumentation implements [Documented] and can be embedded in command types to reduce boilerplate.
 type CommandDocumentation struct {
 	// The usage line. See UsageLine() in [Documented].
 	Usage string

doc.go

@@ -5,11 +5,11 @@ commands, but that's about it. cmder embraces simplicity because sometimes, less
 throughout the project should help you get started.
 
 To define a new command, simply define a type that implements the [Command] interface. If you want your command to have
-additional behaviour like flags or subcommands, simply implement the appropriate interfaces.
+additional behavior like flags or subcommands, simply implement the appropriate interfaces.
 
-  - Bring your own types. cmder doens't force you to use special command structs. As long as you implement our narrow
+  - Bring your own types. cmder doesn't force you to use special command structs. As long as you implement our narrow
     interfaces, you're good to go!
-  - cmder is unobtrustive. Define your command and execute it. Simplicity above all else!
+  - cmder is unobtrusive. Define your command and execute it. Simplicity above all else!
   - cmder is totally stateless making it super easy to unit test your commands. This isn't the case in other libraries.
   - We take great pride in our documentation. If you find anything unclear, please let us know so we can fix it.
 

example_basecommand_embed_test.go

@@ -30,7 +30,7 @@ type implements all required interfaces needed to fulfill [cmder.Command]. You c
 your own implementation.
 
 Example 'semver' manipulates a version string, bumping it up a major/minor/patch version or attaches build/pre-release
-information. By default, input versoins are bumped up a patch version.
+information. By default, input versions are bumped up a patch version.
 `
 
 const SemverExamples = `

example_basecommand_simple_test.go

@@ -86,23 +86,23 @@ func run(ctx context.Context, args []string) error {
 	var out io.Writer = os.Stdout
 
 	if args[0] != "-" {
-		inputf, err := os.Open(args[0])
+		inputFile, err := os.Open(args[0])
 		if err != nil {
 			return err
 		}
 
-		defer inputf.Close()
-		in = inputf
+		defer inputFile.Close()
+		in = inputFile
 	}
 
 	if output != "-" {
-		outputf, err := os.Create(output)
+		outputFile, err := os.Create(output)
 		if err != nil {
 			return err
 		}
 
-		defer outputf.Close()
-		out = outputf
+		defer outputFile.Close()
+		out = outputFile
 	}
 
 	if hexdump {

example_comand_config_test.go

@@ -46,7 +46,7 @@ const MultiConfSettings = `{
 `
 
 const MultiConfDesc = `
-'multi-conf' desmonstrates how you can setup configuration from a configuration file (json), environment variables, and
+'multi-conf' demonstrates how you can setup configuration from a configuration file (json), environment variables, and
 command-line flags. In this example, configuration is evaluated in this order, from lowest to highest precedence:
 
   1. Configuration File  (/etc/multi.conf)

example_exec_option_bind_env_test.go

@@ -10,7 +10,7 @@ import (
 )
 
 func ExampleWithEnvironmentBinding() {
-	os.Setenv("BINDENV_SHOW_FORMAT", "overidden-by-flag")
+	os.Setenv("BINDENV_SHOW_FORMAT", "overridden-by-flag")
 	os.Setenv("BINDENV_SHOW_PAGECOUNT", "20")
 
 	args := []string{"show", "--format=pretty"}

example_exec_option_interspersed_test.go

@@ -28,7 +28,7 @@ func ExampleWithInterspersedArgs() {
 }
 
 const HashDesc = `
-'hash' desmonstrates how cmder can be configured to parse args with interspersed args and flags. The command generates
+'hash' demonstrates how cmder can be configured to parse args with interspersed args and flags. The command generates
 and prints a hash of the concatenated command args.
 `