From 5202073250fd0833bffd6351e1ec7d138926c34d Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Tue, 15 Sep 2026 15:06:37 -0400 Subject: [PATCH 1/4] Add GitHub Actions workflow for codespell on master --- .github/workflows/codespell.yml | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 .github/workflows/codespell.yml diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml new file mode 100644 index 0000000..9458b0c --- /dev/null +++ b/.github/workflows/codespell.yml @@ -0,0 +1,23 @@ +# Codespell configuration is within .codespellrc +--- +name: Codespell + +on: + push: + branches: [master] + pull_request: + branches: [master] + +permissions: + contents: read + +jobs: + codespell: + name: Check for spelling errors + runs-on: ubuntu-latest + + steps: + - name: Checkout + uses: actions/checkout@v6 + - name: Codespell + uses: codespell-project/actions-codespell@8f01853be192eb0f849a5c7d721450e7a467c579 # v2.2 From 51ab5def85137ddcdb24a0f529796e4bd9203e36 Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Tue, 15 Sep 2026 15:06:37 -0400 Subject: [PATCH 2/4] Add rudimentary codespell config --- .codespellrc | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 .codespellrc diff --git a/.codespellrc b/.codespellrc new file mode 100644 index 0000000..d23e4ae --- /dev/null +++ b/.codespellrc @@ -0,0 +1,6 @@ +[codespell] +# Ref: https://github.com/codespell-project/codespell#using-a-config-file +skip = .git,.gitignore,.gitattributes,package-lock.json,*.lock,*.css,*.min.*,.codespellrc +check-hidden = true +# ignore-regex = +# ignore-words-list = From 626555f7f376c4a79252a676bab3309ba58cf552 Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Tue, 15 Sep 2026 15:09:38 -0400 Subject: [PATCH 3/4] Tune codespell config: skip spec/sites fixtures, add nd to ignore list MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Skip */spec/sites/* (external ruby-doc.org HTML fixtures — not our content) - Skip .git-meta (workflow scratch folder for commit/PR messages) - Add 'nd' to ignore-words-list (ordinal suffix in regex like (st|nd|rd|th)) - Fix actions/checkout@v6 → @v4 to match project's existing CI convention Co-Authored-By: Claude Code 2.1.272 / Claude Sonnet 4.6 --- .codespellrc | 8 +++++--- .github/workflows/codespell.yml | 2 +- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/.codespellrc b/.codespellrc index d23e4ae..8988271 100644 --- a/.codespellrc +++ b/.codespellrc @@ -1,6 +1,8 @@ [codespell] # Ref: https://github.com/codespell-project/codespell#using-a-config-file -skip = .git,.gitignore,.gitattributes,package-lock.json,*.lock,*.css,*.min.*,.codespellrc +skip = .git,.git-meta,.gitignore,.gitattributes,package-lock.json,*.lock,*.css,*.min.*,.codespellrc,*/spec/sites/* check-hidden = true -# ignore-regex = -# ignore-words-list = +# ignore-regex = +ignore-words-list = + # nd - ordinal suffix in regex patterns like (st|nd|rd|th) + nd diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml index 9458b0c..1ed0f27 100644 --- a/.github/workflows/codespell.yml +++ b/.github/workflows/codespell.yml @@ -18,6 +18,6 @@ jobs: steps: - name: Checkout - uses: actions/checkout@v6 + uses: actions/checkout@v4 - name: Codespell uses: codespell-project/actions-codespell@8f01853be192eb0f849a5c7d721450e7a467c579 # v2.2 From 6d0c984dc22b5becf20d1bdb462eafa37bd04c9a Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Tue, 15 Sep 2026 15:10:11 -0400 Subject: [PATCH 4/4] [DATALAD RUNCMD] Fix typos detected by codespell - offical -> official (INSTALLATION.md) - incudes -> includes (README.md anchor #incudes -> #includes) - containg -> containing (config/sitediff.example.yaml) - Intialize -> Initialize (lib/sitediff/api.rb) Co-Authored-By: Claude Code 2.1.272 / Claude Sonnet 4.6 === Do not change lines below === { "chain": [], "cmd": "uvx codespell -w", "exit": 0, "extra_inputs": [], "inputs": [], "outputs": [], "pwd": "." } ^^^ Do not change lines above ^^^ --- INSTALLATION.md | 2 +- README.md | 2 +- config/sitediff.example.yaml | 2 +- lib/sitediff/api.rb | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/INSTALLATION.md b/INSTALLATION.md index cfba99b..6750618 100644 --- a/INSTALLATION.md +++ b/INSTALLATION.md @@ -42,7 +42,7 @@ gem install sitediff -v '1.2.1' ## Docker There is a `Dockerfile` in the root of the SiteDiff git repository. It uses -the Docker offical Ruby image. Note that SiteDiff will use port `13080` for the result server. The following Docker image tags are available to be pulled. +the Docker official Ruby image. Note that SiteDiff will use port `13080` for the result server. The following Docker image tags are available to be pulled. * latest (master branch) * 1.0.0 diff --git a/README.md b/README.md index f270315..2e80b24 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ - [ignore_whitespace](#ignore_whitespace) - [remove_html_comments](#remove_html_comments) - [before / after](#before--after) - - [includes](#incudes) + - [includes](#includes) - [dom_transform](#dom_transform) - [remove](#remove) - [strip](#strip) diff --git a/config/sitediff.example.yaml b/config/sitediff.example.yaml index 59c307d..13a5ad8 100644 --- a/config/sitediff.example.yaml +++ b/config/sitediff.example.yaml @@ -46,7 +46,7 @@ selector: 'body' # General regular expression rules, applied to both versions of the site. sanitization: - # Normalize input tags containg random tokens. + # Normalize input tags containing random tokens. - title: Remove form-build-id pattern: '' substitute: '' diff --git a/lib/sitediff/api.rb b/lib/sitediff/api.rb index 5010a48..8e1d9c4 100644 --- a/lib/sitediff/api.rb +++ b/lib/sitediff/api.rb @@ -20,7 +20,7 @@ def initialize(directory, config_file = nil) end ## - # Intialize a SiteDiff project. + # Initialize a SiteDiff project. # # Calling: # SiteDiff::Api.init(