chore: add typos pre commit hook (#435)

* chore: add typos pre commit hook

Signed-off-by: Sertac Ozercan <[email protected]>

Author: sozercan

.pre-commit-config.yaml

@@ -1,14 +1,18 @@
 repos:
 - repo: https://github.com/gitleaks/gitleaks
-  rev: v8.16.3
+  rev: v8.21.2
   hooks:
   - id: gitleaks
 - repo: https://github.com/golangci/golangci-lint
-  rev: v1.52.2
+  rev: v1.62.0
   hooks:
   - id: golangci-lint
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.4.0
+  rev: v5.0.0
   hooks:
   - id: end-of-file-fixer
   - id: trailing-whitespace
+- repo: https://github.com/crate-ci/typos
+  rev: v1.27.3
+  hooks:
+    - id: typos

_typos.toml

@@ -0,0 +1,2 @@
+[default.extend-words]
+ba = "ba"

cmd/test2json2gha/main.go

@@ -113,7 +113,7 @@ func do(in io.Reader, out io.Writer, modName string) (bool, error) {
 		}
 
 		if te.Test == "" {
-			// Don't bother processing events that aren't specfically for a test
+			// Don't bother processing events that aren't specifically for a test
 			// Go adds extra events in for package level info that we don't need.
 			continue
 		}

docs/spec.schema.json

@@ -277,7 +277,7 @@
 			},
 			"additionalProperties": false,
 			"type": "object",
-			"description": "CheckOutput is used to specify the exepcted output of a check, such as stdout/stderr or a file."
+			"description": "CheckOutput is used to specify the expected output of a check, such as stdout/stderr or a file."
 		},
 		"Command": {
 			"properties": {
@@ -520,7 +520,7 @@
 						"type": "string"
 					},
 					"type": "array",
-					"description": "Version is a list of version constraints for the package.\nThe format of these strings is depenendent on the package manager of the target system.\nExamples:\n  [\"\u003e=1.0.0\", \"\u003c2.0.0\"]"
+					"description": "Version is a list of version constraints for the package.\nThe format of these strings is dependent on the package manager of the target system.\nExamples:\n  [\"\u003e=1.0.0\", \"\u003c2.0.0\"]"
 				},
 				"arch": {
 					"items": {
@@ -728,7 +728,7 @@
 						"$ref": "#/$defs/SourceGenerator"
 					},
 					"type": "array",
-					"description": "Generate is the list generators to run on the source.\n\nGenerators are used to generate additional sources from this source.\nAs an example the `godmod` generator can be used to generate a go module cache from a go source.\nHow a genator operates is dependent on the actual generator.\nGeneators may also cauuse modifications to the build environment.\n\nCurrently only one generator is supported: \"gomod\""
+					"description": "Generate is the list generators to run on the source.\n\nGenerators are used to generate additional sources from this source.\nAs an example the `gomod` generator can be used to generate a go module cache from a go source.\nHow a generator operates is dependent on the actual generator.\nGenerators may also cauuse modifications to the build environment.\n\nCurrently only one generator is supported: \"gomod\""
 				}
 			},
 			"additionalProperties": false,
@@ -853,11 +853,11 @@
 			"properties": {
 				"file": {
 					"$ref": "#/$defs/SourceInlineFile",
-					"description": "File is the inline file to generate.\nFile is treated as a literal single file.\n[SourceIsDir] will return false when this is set.\nThis is mutally exclusive with [Dir]"
+					"description": "File is the inline file to generate.\nFile is treated as a literal single file.\n[SourceIsDir] will return false when this is set.\nThis is mutually exclusive with [Dir]"
 				},
 				"dir": {
 					"$ref": "#/$defs/SourceInlineDir",
-					"description": "Dir creates a directory with the given files and directories.\n[SourceIsDir] will return true when this is set.\nThis is mutally exclusive with [File]"
+					"description": "Dir creates a directory with the given files and directories.\n[SourceIsDir] will return true when this is set.\nThis is mutually exclusive with [File]"
 				}
 			},
 			"additionalProperties": false,
@@ -1061,7 +1061,7 @@
 						"$ref": "#/$defs/TestSpec"
 					},
 					"type": "array",
-					"description": "Tests are the list of tests to run for the package that should work regardless of target OS\nEach item in this list is run with a separate rootfs and cannot interact with other tests.\nEach [TestSpec] is run with a separate rootfs, asyncronously from other [TestSpec]."
+					"description": "Tests are the list of tests to run for the package that should work regardless of target OS\nEach item in this list is run with a separate rootfs and cannot interact with other tests.\nEach [TestSpec] is run with a separate rootfs, asynchronously from other [TestSpec]."
 				}
 			},
 			"additionalProperties": false,

frontend/deb/debroot.go

@@ -30,7 +30,7 @@ var patchHeader []byte
 var debianInstall []byte
 
 // This creates a directory in the debian root directory for each patch, and copies the patch files into it.
-// The format for each patch dir matches what would normaly be under `debian/patches`, just that this is a separate dir for every source we are patching
+// The format for each patch dir matches what would normally be under `debian/patches`, just that this is a separate dir for every source we are patching
 // This is purely for documenting in the source package how patches are applied in a more readable way than the big merged patch file.
 func sourcePatchesDir(sOpt dalec.SourceOpts, base llb.State, dir, name string, spec *dalec.Spec, opts ...llb.ConstraintsOpt) ([]llb.State, error) {
 	patchesPath := filepath.Join(dir, name)

frontend/deb/template_control.go

@@ -78,7 +78,7 @@ func (w *controlWrapper) depends(buf io.Writer, depsSpec *dalec.PackageDependenc
 	}
 
 	// Add in deps vars that will get resolved by debbuild
-	// In some cases these are not neccessary (maybe even most), but when they are
+	// In some cases these are not necessary (maybe even most), but when they are
 	// it is important.
 	// When not needed lintian may throw warnings but that's ok.
 	// If these aren't actually needed they'll resolve to nothing and don't cause

frontend/deb/template_rules.go

@@ -136,7 +136,7 @@ func (w *rulesWrapper) OverrideSystemd() (fmt.Stringer, error) {
 		// custom postinst/postrm script.
 		//
 		// We also only need to do this once per basename, so we don't need to
-		// itterate over every unit.
+		// iterate over every unit.
 
 		// Get the first key which we'll use to check if the unit is enabled.
 		// Either all units are enabled or not enabled OR we need to do custom enable

frontend/gateway.go

@@ -228,14 +228,14 @@ func Warn(ctx context.Context, client gwclient.Client, st llb.State, msg string)
 
 	def, err := st.Marshal(ctx)
 	if err != nil {
-		bklog.G(ctx).WithError(err).WithField("warn", msg).Warn("Error marshalling state for outputing warning message")
+		bklog.G(ctx).WithError(err).WithField("warn", msg).Warn("Error marshalling state for outputting warning message")
 	}
 
 	var dgst digest.Digest
 	if def != nil {
 		dgst, err = def.Head()
 		if err != nil {
-			bklog.G(ctx).WithError(err).WithField("warn", msg).Warn("Could not get state digest for outputing warning message")
+			bklog.G(ctx).WithError(err).WithField("warn", msg).Warn("Could not get state digest for outputting warning message")
 		}
 	}
 

frontend/jammy/handle_container.go

@@ -122,7 +122,7 @@ func buildImageRootfs(worker llb.State, spec *dalec.Spec, sOpt dalec.SourceOpts,
 			tmp := llb.Scratch().File(llb.Mkfile("tmp", 0o644, nil))
 			// Warning: HACK here
 			// The base ubuntu image has this `excludes` config file which prevents
-			// installation of a lot of thigns, including doc files.
+			// installation of a lot of things, including doc files.
 			// This is mounting over that file with an empty file so that our test suite
 			// passes (as it is looking at these files).
 			llb.AddMount("/etc/dpkg/dpkg.cfg.d/excludes", tmp, llb.SourcePath("tmp")).SetRunOption(cfg)

frontend/mux.go

@@ -203,7 +203,7 @@ func (m *BuildMux) loadSpec(ctx context.Context, client gwclient.Client) (*dalec
 		return nil, err
 	}
 
-	// Note: this is not suitable for passing to builds since it does ot have platform information
+	// Note: this is not suitable for passing to builds since it does not have platform information
 	spec, err := LoadSpec(ctx, dc, nil)
 	if err != nil {
 		return nil, err
@@ -220,7 +220,7 @@ func maybeSetDalecTargetKey(client gwclient.Client, key string) gwclient.Client
 		return client
 	}
 
-	// optimization to help prevent uneccessary grpc requests
+	// optimization to help prevent unnecessary grpc requests
 	// The gateway client will make a grpc request to get the build opts from the gateway.
 	// This just caches those opts locally.
 	// If the client is already a clientWithCustomOpts, then the opts are already cached.
@@ -239,7 +239,7 @@ func (m *BuildMux) list(ctx context.Context, client gwclient.Client, target stri
 	if target == "" {
 		check = maps.Keys(m.handlers)
 	} else {
-		// Use the target as a filter so the response only incldues routes that are underneath the target
+		// Use the target as a filter so the response only includes routes that are underneath the target
 		check = append(check, target)
 	}
 
@@ -309,7 +309,7 @@ func (m *BuildMux) lookupTarget(ctx context.Context, target string) (matchedPatt
 	// cases for `t` are as follows:
 	//    1. may have an exact match in the handlers (ideal)
 	//    2. No matching handler and `target == ""` and there is a default handler set (assume default handler)
-	//    3. may have a prefix match in the handlers, e.g. hander for `foo`, `target == "foo/bar"` (assume nested route)
+	//    3. may have a prefix match in the handlers, e.g. handler for `foo`, `target == "foo/bar"` (assume nested route)
 	//    4. No match in the handlers (error)
 	h, ok := m.handlers[target]
 	if ok {