From 3bbbfbf3b5d3a9b5993b61fc1742e6977972003d Mon Sep 17 00:00:00 2001 From: Mike Farah Date: Sat, 20 Dec 2025 19:06:21 +1100 Subject: [PATCH] Include MD files in spell checker --- CODE_OF_CONDUCT.md | 12 ++++++------ agents.md | 10 +--------- pkg/yqlib/doc/operators/datetime.md | 2 +- pkg/yqlib/doc/operators/headers/datetime.md | 2 +- project-words.txt | 7 +++++++ scripts/spelling.sh | 2 +- 6 files changed, 17 insertions(+), 18 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index d2a542d7..2f3359b9 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -11,7 +11,7 @@ appearance, race, religion, or sexual identity and orientation. ## Our Standards -Examples of behavior that contributes to creating a positive environment +Examples of behaviour that contributes to creating a positive environment include: * Using welcoming and inclusive language @@ -20,7 +20,7 @@ include: * Focusing on what is best for the community * Showing empathy towards other community members -Examples of unacceptable behavior by participants include: +Examples of unacceptable behaviour by participants include: * The use of sexualized language or imagery and unwelcome sexual attention or advances @@ -34,13 +34,13 @@ Examples of unacceptable behavior by participants include: ## Our Responsibilities Project maintainers are responsible for clarifying the standards of acceptable -behavior and are expected to take appropriate and fair corrective action in -response to any instances of unacceptable behavior. +behaviour and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behaviour. Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or -permanently any contributor for other behaviors that they deem inappropriate, +permanently any contributor for other behaviours that they deem inappropriate, threatening, offensive, or harmful. ## Scope @@ -54,7 +54,7 @@ further defined and clarified by project maintainers. ## Enforcement -Instances of abusive, harassing, or otherwise unacceptable behavior may be +Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported by contacting the project team at mikefarah@gmail.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is diff --git a/agents.md b/agents.md index c91d19a2..54cd94bc 100644 --- a/agents.md +++ b/agents.md @@ -4,7 +4,7 @@ - run ./scripts/format.sh to format the code; then ./scripts/check.sh lint and finally ./scripts/spelling.sh to check spelling. - Add comprehensive tests to cover the changes - Run test suite to ensure there is no regression -- Use UK english spelling (e.g. Colorisation not Colorization) +- Use UK english spelling ❌ **DON'T:** - Git add or commit @@ -197,14 +197,6 @@ Tests must be implemented in `_test.go` following the `formatScenario` p ## Common Patterns -### Scalar-Only Formats -Some formats only work with scalars (like base64, uri): -```go -if node.guessTagFromCustomType() != "!!str" { - return fmt.Errorf("cannot encode %v as , can only operate on strings", node.Tag) -} -``` - ### Format with Indentation Use preferences to control output formatting: ```go diff --git a/pkg/yqlib/doc/operators/datetime.md b/pkg/yqlib/doc/operators/datetime.md index 685618fc..559998ab 100644 --- a/pkg/yqlib/doc/operators/datetime.md +++ b/pkg/yqlib/doc/operators/datetime.md @@ -2,7 +2,7 @@ Various operators for parsing and manipulating dates. -## Date time formattings +## Date time formatting This uses Golang's built in time library for parsing and formatting date times. When not specified, the RFC3339 standard is assumed `2006-01-02T15:04:05Z07:00` for parsing. diff --git a/pkg/yqlib/doc/operators/headers/datetime.md b/pkg/yqlib/doc/operators/headers/datetime.md index 9efc1357..40667532 100644 --- a/pkg/yqlib/doc/operators/headers/datetime.md +++ b/pkg/yqlib/doc/operators/headers/datetime.md @@ -2,7 +2,7 @@ Various operators for parsing and manipulating dates. -## Date time formattings +## Date time formatting This uses Golang's built in time library for parsing and formatting date times. When not specified, the RFC3339 standard is assumed `2006-01-02T15:04:05Z07:00` for parsing. diff --git a/project-words.txt b/project-words.txt index 9385bfd8..be7d4934 100644 --- a/project-words.txt +++ b/project-words.txt @@ -278,3 +278,10 @@ zclconf cty go-cty Colorisation +goimports +errorlint +RDBMS +expeñded +bananabananabananabanana +edwinjhlee +flox \ No newline at end of file diff --git a/scripts/spelling.sh b/scripts/spelling.sh index 00c39f74..8de4e08a 100755 --- a/scripts/spelling.sh +++ b/scripts/spelling.sh @@ -1,3 +1,3 @@ #!/bin/bash -npx cspell --no-progress "**/*.{sh,go}" \ No newline at end of file +npx cspell --no-progress "**/*.{sh,go,md}" \ No newline at end of file