Merge pull request #1683 from cloudflare/typos

prymitive · web-flow · commit 8adf8f194fd5 · 2026-01-19T10:53:48.000Z
Use typos for spell checks
diff --git a/.github/spellcheck/config.yml b/.github/spellcheck/config.yml
diff --git a/.github/spellcheck/wordlist.txt b/.github/spellcheck/wordlist.txt
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -15,9 +15,7 @@ jobs:
           show-progress: false
 
       - name: Spellcheck
-        uses: rojopolis/spellcheck-github-actions@2b78e363a487cd137993dc2cddc17a43c89bf7a1 # 0.57.0
-        with:
-          config_path: .github/spellcheck/config.yml
+        uses: crate-ci/typos@v1.34.0
 
   markdown:
     name: Markdownlint
diff --git a/_typos.toml b/_typos.toml
@@ -0,0 +1,38 @@
+[default.extend-words]
+# Project-specific terms
+automaxprocs = "automaxprocs"
+cloudflare = "cloudflare"
+deduplicated = "deduplicated"
+endraw = "endraw"
+gitlab = "gitlab"
+golang = "golang"
+hoc = "hoc"
+humanize = "humanize"
+promql = "promql"
+prymitive = "prymitive"
+pushgateway = "pushgateway"
+rulefmt = "rulefmt"
+samber = "samber"
+symlinked = "symlinked"
+templated = "templated"
+tokenize = "tokenize"
+unmarshal = "unmarshal"
+
+[default.extend-identifiers]
+# Variable name abbreviation for PromQLNode
+pn = "pn"
+# Variable name abbreviation for BitBucketCommentAnchor
+ba = "ba"
+
+[files]
+extend-exclude = [
+    "go.sum",
+    # Test rules file contains intentional typos from real-world Prometheus rules
+    "internal/parser/testrules.yml",
+    # Test files with intentional typos in metric names or example data
+    "cmd/pint/tests/*.txt",
+    "internal/checks/*_test.snap",
+    "internal/checks/*_test.go",
+    # Documentation examples showing typos that pint catches
+    "docs/checks/yaml/parse.md",
+]
diff --git a/internal/comments/comments.go b/internal/comments/comments.go
@@ -161,9 +161,9 @@ func parseSnooze(s string) (snz Snooze, err error) {
 	return snz, nil
 }
 
-func parseValue(typ Type, s string, line int) (CommentValue, error) {
+func parseValue(commentType Type, s string, line int) (CommentValue, error) {
 	// nolint:exhaustive
-	switch typ {
+	switch commentType {
 	case IgnoreFileType, IgnoreLineType, IgnoreBeginType, IgnoreEndType, IgnoreNextLineType:
 		if s != "" {
 			return nil, fmt.Errorf("unexpected comment suffix: %q", s)
@@ -342,20 +342,20 @@ func Parse(lineno int, text string) (comments []Comment) {
 	return comments
 }
 
-func Only[T any](src []Comment, typ Type) []T {
+func Only[T any](src []Comment, commentType Type) []T {
 	dst := make([]T, 0, len(src))
 	for _, c := range src {
-		if c.Type != typ {
+		if c.Type != commentType {
 			continue
 		}
 		dst = append(dst, c.Value.(T))
 	}
 	return dst
 }
 
-func IsRuleComment(typ Type) bool {
+func IsRuleComment(commentType Type) bool {
 	// nolint:exhaustive
-	switch typ {
+	switch commentType {
 	case RuleOwnerType, DisableType, SnoozeType, RuleSetType:
 		return true
 	}
diff --git a/internal/config/alerts.go b/internal/config/alerts.go
@@ -40,7 +40,7 @@ func (as AlertsSettings) validate() error {
 			return err
 		}
 		if as.MinCount <= 0 && sev > checks.Information {
-			return fmt.Errorf("cannot set serverity to %q when minCount is 0", as.Severity)
+			return fmt.Errorf("cannot set severity to %q when minCount is 0", as.Severity)
 		}
 	}
 	return nil
diff --git a/internal/config/alerts_test.go b/internal/config/alerts_test.go
@@ -72,7 +72,7 @@ func TestAlertsSettings(t *testing.T) {
 				MinCount: 0,
 				Severity: "bug",
 			},
-			err: errors.New(`cannot set serverity to "bug" when minCount is 0`),
+			err: errors.New(`cannot set severity to "bug" when minCount is 0`),
 		},
 		{
 			conf: AlertsSettings{
diff --git a/internal/config/config_test.go b/internal/config/config_test.go
@@ -1907,7 +1907,7 @@ func TestConfigErrors(t *testing.T) {
 	severity = "bug"
   }
 }`,
-			err: `cannot set serverity to "bug" when minCount is 0`,
+			err: `cannot set severity to "bug" when minCount is 0`,
 		},
 		{
 			config: `rule {
diff --git a/internal/discovery/git_branch.go b/internal/discovery/git_branch.go
@@ -320,9 +320,9 @@ func isEntryIdentical(b, a *Entry) bool {
 	return true
 }
 
-func findRulesByName(entries []*Entry, name string, typ parser.RuleType) (nomatch, match []*Entry) {
+func findRulesByName(entries []*Entry, name string, ruleType parser.RuleType) (nomatch, match []*Entry) {
 	for _, entry := range entries {
-		if entry.PathError == nil && entry.Rule.Type() == typ && entry.Rule.Name() == name {
+		if entry.PathError == nil && entry.Rule.Type() == ruleType && entry.Rule.Name() == name {
 			match = append(match, entry)
 		} else {
 			nomatch = append(nomatch, entry)
diff --git a/internal/git/changes.go b/internal/git/changes.go
@@ -347,8 +347,8 @@ func getTypeForPath(cmd CommandRunner, commit, fpath string) PathType {
 }
 
 // recursively find the final target of a symlink.
-func resolveSymlinkTarget(cmd CommandRunner, commit, fpath string, typ PathType) string {
-	if typ != Symlink {
+func resolveSymlinkTarget(cmd CommandRunner, commit, fpath string, pathType PathType) string {
+	if pathType != Symlink {
 		return fpath
 	}
 	raw := string(getContentAtCommit(cmd, commit, fpath))
diff --git a/internal/parser/parser_test.go b/internal/parser/parser_test.go
@@ -3756,7 +3756,7 @@ groups:
 						Rules: []parser.Rule{
 							{
 								Error: parser.ParseError{
-									Err:  errors.New("rule definion must be a mapping, got list"),
+									Err:  errors.New("rule definition must be a mapping, got list"),
 									Line: 5,
 								},
 							},
diff --git a/internal/parser/source/source.go b/internal/parser/source/source.go
@@ -440,17 +440,17 @@ func (s *Source) checkJoinedLabels(expr string, n *promParser.BinaryExpr, dst So
 	return dead
 }
 
-func (s *Source) useLabelsNotExcluded(exluded []string) {
+func (s *Source) useLabelsNotExcluded(excluded []string) {
 	// Iterating over a map can yield labels in different order each time
 	// so append labels to an extra slice, sort it, and then append the
-	// sorted reults to UsedLabels.
+	// sorted results to UsedLabels.
 	// Without this tests might show a diff sometimes.
 	toAdd := make([]string, 0, len(s.Labels))
 	for name, lt := range s.Labels {
 		if lt.Kind == ImpossibleLabel {
 			continue
 		}
-		if !slices.Contains(exluded, name) {
+		if !slices.Contains(excluded, name) {
 			toAdd = appendToSlice(toAdd, name)
 		}
 	}
@@ -1357,7 +1357,7 @@ func parseBinOps(expr string, n *promParser.BinaryExpr) (src []Source) {
 				// If LHS can NOT be empty then RHS is dead code.
 				if !lhsCanBeEmpty {
 					rs.DeadInfo = &DeadInfo{
-						Reason:   "The left hand side always returs something and so the right hand side is never used.",
+						Reason:   "The left hand side always returns something and so the right hand side is never used.",
 						Fragment: rs.Position,
 					}
 				}
diff --git a/internal/parser/source/source_test.snap b/internal/parser/source/source_test.snap
@@ -397,7 +397,7 @@ output:
           addedlabels: []
           src:
             deadInfo:
-                reason: The left hand side always returs something and so the right hand side is never used.
+                reason: The left hand side always returns something and so the right hand side is never used.
                 fragment:
                     start: 35
                     end: 38
@@ -473,7 +473,7 @@ output:
           addedlabels: []
           src:
             deadInfo:
-                reason: The left hand side always returs something and so the right hand side is never used.
+                reason: The left hand side always returns something and so the right hand side is never used.
                 fragment:
                     start: 35
                     end: 38
@@ -4859,7 +4859,7 @@ output:
       type: function
       fixedLabels: true
     - deadInfo:
-        reason: The left hand side always returs something and so the right hand side is never used.
+        reason: The left hand side always returns something and so the right hand side is never used.
         fragment:
             start: 13
             end: 16
diff --git a/internal/parser/strict.go b/internal/parser/strict.go
@@ -254,7 +254,7 @@ func (p Parser) parseRuleStrict(rule *yaml.Node, contentLines []string) Rule {
 		return Rule{
 			Error: ParseError{
 				Line: rule.Line,
-				Err:  fmt.Errorf("rule definion must be a %s, got %s", describeTag(mapTag), describeTag(rule.ShortTag())),
+				Err:  fmt.Errorf("rule definition must be a %s, got %s", describeTag(mapTag), describeTag(rule.ShortTag())),
 			},
 		}
 	}
diff --git a/internal/reporter/bitbucket_api.go b/internal/reporter/bitbucket_api.go
@@ -708,7 +708,7 @@ func (bb bitBucketAPI) limitComments(src []BitBucketPendingComment) []BitBucketP
 	comments := src[:bb.maxComments]
 	comments = append(comments, BitBucketPendingComment{
 		Text: fmt.Sprintf(`This pint run would create %d comment(s), which is more than %d limit configured for pint.
-%d comments were skipped and won't be visibile on this PR.`, len(src), bb.maxComments, len(src)-bb.maxComments),
+%d comments were skipped and won't be visible on this PR.`, len(src), bb.maxComments, len(src)-bb.maxComments),
 		Severity: "NORMAL",
 		Anchor: BitBucketPendingCommentAnchor{ // nolint: exhaustruct
 			DiffType: "EFFECTIVE",
diff --git a/internal/reporter/bitbucket_comments_test.go b/internal/reporter/bitbucket_comments_test.go
@@ -557,7 +557,7 @@ func TestBitBucketMakeComments(t *testing.T) {
 					},
 				},
 				{
-					Text:     "This pint run would create 5 comment(s), which is more than 2 limit configured for pint.\n3 comments were skipped and won't be visibile on this PR.",
+					Text:     "This pint run would create 5 comment(s), which is more than 2 limit configured for pint.\n3 comments were skipped and won't be visible on this PR.",
 					Severity: "NORMAL",
 					Anchor: BitBucketPendingCommentAnchor{
 						DiffType: "EFFECTIVE",
diff --git a/internal/reporter/github_test.go b/internal/reporter/github_test.go
@@ -367,7 +367,7 @@ func TestGitHubReporter(t *testing.T) {
 					switch b {
 					case `{"body":":stop_sign: **Bug** reported by [pint](https://cloudflare.github.io/pint/) **mock1** check.\n\n------\n\nsyntax error1\n\nsyntax details1\n\n------\n\n:information_source: To see documentation covering this check and instructions on how to resolve it [click here](https://cloudflare.github.io/pint/checks/mock1.html).\n","path":"foo.txt","line":2,"side":"RIGHT","commit_id":"HEAD"}`:
 					case `{"body":":stop_sign: **Bug** reported by [pint](https://cloudflare.github.io/pint/) **mock2** check.\n\n------\n\nsyntax error2\n\nsyntax details2\n\n------\n\n:information_source: To see documentation covering this check and instructions on how to resolve it [click here](https://cloudflare.github.io/pint/checks/mock2.html).\n","path":"foo.txt","line":2,"side":"RIGHT","commit_id":"HEAD"}`:
-					case `{"body":"This pint run would create 4 comment(s), which is more than 2 limit configured for pint.\n2 comments were skipped and won't be visibile on this PR."}`:
+					case `{"body":"This pint run would create 4 comment(s), which is more than 2 limit configured for pint.\n2 comments were skipped and won't be visible on this PR."}`:
 					default:
 						t.Errorf("Unexpected comment: %s", b)
 					}
@@ -473,7 +473,7 @@ func TestGitHubReporter(t *testing.T) {
 				if r.Method == http.MethodPost && r.URL.Path == "/api/v3/repos/foo/bar/issues/123/comments" {
 					body, _ := io.ReadAll(r.Body)
 					b := strings.TrimSpace(strings.TrimRight(string(body), "\n\t\r"))
-					if b == `{"body":"This pint run would create 4 comment(s), which is more than the limit configured for pint (2).\n2 comment(s) were skipped and won't be visibile on this PR."}` {
+					if b == `{"body":"This pint run would create 4 comment(s), which is more than the limit configured for pint (2).\n2 comment(s) were skipped and won't be visible on this PR."}` {
 						w.WriteHeader(http.StatusInternalServerError)
 						_, _ = w.Write([]byte("Cannot create issue comment"))
 						return
diff --git a/internal/reporter/gitlab.go b/internal/reporter/gitlab.go
@@ -630,5 +630,5 @@ func loggifyDiscussion(opt *gitlab.CreateMergeRequestDiscussionOptions) (attrs [
 
 func tooManyCommentsMsg(nr, m int) string {
 	return fmt.Sprintf(`This pint run would create %d comment(s), which is more than the limit configured for pint (%d).
-%d comment(s) were skipped and won't be visibile on this PR.`, nr, m, nr-m)
+%d comment(s) were skipped and won't be visible on this PR.`, nr, m, nr-m)
 }
diff --git a/internal/reporter/gitlab_test.go b/internal/reporter/gitlab_test.go
@@ -453,7 +453,7 @@ func TestGitLabReporter(t *testing.T) {
 					Position: discPosition("foo.txt", 1),
 				}).ReturnJSON(gitlab.Response{})
 				s.ExpectPost(apiDiscussions(1, false)).WithBodyJSON(gitlab.CreateMergeRequestDiscussionOptions{
-					Body: gitlab.Ptr("This pint run would create 3 comment(s), which is more than the limit configured for pint (1).\n2 comment(s) were skipped and won't be visibile on this PR."),
+					Body: gitlab.Ptr("This pint run would create 3 comment(s), which is more than the limit configured for pint (1).\n2 comment(s) were skipped and won't be visible on this PR."),
 				}).ReturnJSON(gitlab.Response{})
 			}),
 			errorHandler: func(err error) error {
@@ -643,7 +643,7 @@ Below is the list of checks that were disabled for each Prometheus server define
 					},
 					{
 						ID:    "300",
-						Notes: []*gitlab.Note{discNote(301, 123, "This pint run would create 3 comment(s), which is more than the limit configured for pint (1).\n2 comment(s) were skipped and won't be visibile on this PR.", nil)},
+						Notes: []*gitlab.Note{discNote(301, 123, "This pint run would create 3 comment(s), which is more than the limit configured for pint (1).\n2 comment(s) were skipped and won't be visible on this PR.", nil)},
 					},
 				})
 				s.ExpectPost(apiDiscussions(1, false)).WithBodyJSON(gitlab.CreateMergeRequestDiscussionOptions{

Original file line number	Diff line number	Diff line change
`@@ -161,9 +161,9 @@ func parseSnooze(s string) (snz Snooze, err error) {`
`161`	`161`	`return snz, nil`
`162`	`162`	`}`
`163`	`163`
`164`		`-func parseValue(typ Type, s string, line int) (CommentValue, error) {`
	`164`	`+func parseValue(commentType Type, s string, line int) (CommentValue, error) {`
`165`	`165`	`// nolint:exhaustive`
`166`		`- switch typ {`
	`166`	`+ switch commentType {`
`167`	`167`	`case IgnoreFileType, IgnoreLineType, IgnoreBeginType, IgnoreEndType, IgnoreNextLineType:`
`168`	`168`	`if s != "" {`
`169`	`169`	`return nil, fmt.Errorf("unexpected comment suffix: %q", s)`
`@@ -342,20 +342,20 @@ func Parse(lineno int, text string) (comments []Comment) {`
`342`	`342`	`return comments`
`343`	`343`	`}`
`344`	`344`
`345`		`-func Only[T any](src []Comment, typ Type) []T {`
	`345`	`+func Only[T any](src []Comment, commentType Type) []T {`
`346`	`346`	`dst := make([]T, 0, len(src))`
`347`	`347`	`for _, c := range src {`
`348`		`- if c.Type != typ {`
	`348`	`+ if c.Type != commentType {`
`349`	`349`	`continue`
`350`	`350`	`}`
`351`	`351`	`dst = append(dst, c.Value.(T))`
`352`	`352`	`}`
`353`	`353`	`return dst`
`354`	`354`	`}`
`355`	`355`
`356`		`-func IsRuleComment(typ Type) bool {`
	`356`	`+func IsRuleComment(commentType Type) bool {`
`357`	`357`	`// nolint:exhaustive`
`358`		`- switch typ {`
	`358`	`+ switch commentType {`
`359`	`359`	`case RuleOwnerType, DisableType, SnoozeType, RuleSetType:`
`360`	`360`	`return true`
`361`	`361`	`}`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ func (as AlertsSettings) validate() error {`
`40`	`40`	`return err`
`41`	`41`	`}`
`42`	`42`	`if as.MinCount <= 0 && sev > checks.Information {`
`43`		`- return fmt.Errorf("cannot set serverity to %q when minCount is 0", as.Severity)`
	`43`	`+ return fmt.Errorf("cannot set severity to %q when minCount is 0", as.Severity)`
`44`	`44`	`}`
`45`	`45`	`}`
`46`	`46`	`return nil`
Original file line number	Diff line number	Diff line change
`@@ -72,7 +72,7 @@ func TestAlertsSettings(t *testing.T) {`
`72`	`72`	`MinCount: 0,`
`73`	`73`	`Severity: "bug",`
`74`	`74`	`},`
`75`		- err: errors.New(`cannot set serverity to "bug" when minCount is 0`),
	`75`	+ err: errors.New(`cannot set severity to "bug" when minCount is 0`),
`76`	`76`	`},`
`77`	`77`	`{`
`78`	`78`	`conf: AlertsSettings{`
Original file line number	Diff line number	Diff line change
`@@ -1907,7 +1907,7 @@ func TestConfigErrors(t *testing.T) {`
`1907`	`1907`	`severity = "bug"`
`1908`	`1908`	`}`
`1909`	`1909`	}`,
`1910`		- err: `cannot set serverity to "bug" when minCount is 0`,
	`1910`	+ err: `cannot set severity to "bug" when minCount is 0`,
`1911`	`1911`	`},`
`1912`	`1912`	`{`
`1913`	`1913`	config: `rule {
Original file line number	Diff line number	Diff line change
`@@ -347,8 +347,8 @@ func getTypeForPath(cmd CommandRunner, commit, fpath string) PathType {`
`347`	`347`	`}`
`348`	`348`
`349`	`349`	`// recursively find the final target of a symlink.`
`350`		`-func resolveSymlinkTarget(cmd CommandRunner, commit, fpath string, typ PathType) string {`
`351`		`- if typ != Symlink {`
	`350`	`+func resolveSymlinkTarget(cmd CommandRunner, commit, fpath string, pathType PathType) string {`
	`351`	`+ if pathType != Symlink {`
`352`	`352`	`return fpath`
`353`	`353`	`}`
`354`	`354`	`raw := string(getContentAtCommit(cmd, commit, fpath))`