Skip to content

Add codespell support with configuration and fixes#1155

Open
yarikoptic wants to merge 5 commits intojpanther:devfrom
yarikoptic:enh-codespell
Open

Add codespell support with configuration and fixes#1155
yarikoptic wants to merge 5 commits intojpanther:devfrom
yarikoptic:enh-codespell

Conversation

@yarikoptic
Copy link
Copy Markdown
Contributor

Add codespell configuration and fix existing typos.

More about codespell: https://github.com/codespell-project/codespell

I personally introduced it to dozens if not hundreds of projects already and so far only positive feedback.

CI workflow has 'permissions' set only to 'read' so also should be safe.

Changes

Configuration & Infrastructure

  • Added .codespellrc configuration with comprehensive skip patterns
  • Created GitHub Actions workflow to check spelling on push and PRs to dev
  • Added .npm/ to .gitignore (local cache directory)

Skip Patterns

Configured to skip:

  • Minified JS libraries (*/lib/*)
  • Cache directories (.npm, .cache)
  • Generated Lighthouse HTML report (lighthouse.html)
  • Sample/demo content with Lorem Ipsum (samples)
  • Non-English locale files (*.de.md, *.es.md, *.de.toml, *.es.toml, *.ja.toml, *.zh-Hans.toml)
  • SVG, CSS, lock files, i18n directories

Typo Fixes (9 fixes in 6 files)

All non-ambiguous, fixed automatically via codespell -w:

  • paramaterparameter (CHANGELOG.md)
  • exclaimationexclamation (shortcodes docs)
  • strucuredstructured (version-2 announcement)
  • languagueslanguages (upgrade docs — English, Japanese, Chinese versions)
  • requriedrequired (upgrade docs)
  • dispalyeddisplayed (upgrade docs)

Historical Context

This project has had 55 prior commits fixing typos manually, demonstrating the value of automated spell-checking.

Testing

  • Codespell passes with zero errors after all fixes

🤖 Generated with Claude Code and love to typos free code

yarikoptic and others added 5 commits March 5, 2026 18:06
Skip minified JS libraries (*/lib/*), cache dirs (.npm, .cache),
generated Lighthouse report, sample/demo content (Lorem Ipsum),
and non-English locale files (*.de.*, *.es.*, etc.) to eliminate
false positives from foreign language content.

Co-Authored-By: Claude Code 2.1.63 / Claude Opus 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Code 2.1.63 / Claude Opus 4.6 <noreply@anthropic.com>
Fixed typos:
- paramater -> parameter (CHANGELOG.md)
- exclaimation -> exclamation (exampleSite/content/docs/shortcodes/index.md)
- strucured -> structured (exampleSite/content/docs/version-2/_index.md)
- languagues -> languages (exampleSite/content/docs/version-2/upgrade/index.md, index.ja.md, index.zh-Hans.md)
- requried -> required (exampleSite/content/docs/version-2/upgrade/index.md)
- dispalyed -> displayed (exampleSite/content/docs/version-2/upgrade/index.md)

Co-Authored-By: Claude Code 2.1.63 / Claude Opus 4.6 <noreply@anthropic.com>

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "uvx codespell -w",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
@netlify
Copy link
Copy Markdown

netlify bot commented Mar 5, 2026

Deploy Preview for hugo-congo ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit a488a93
🔍 Latest deploy log https://app.netlify.com/projects/hugo-congo/deploys/69aa12d8dc96b4000892787d
😎 Deploy Preview https://deploy-preview-1155--hugo-congo.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Mar 5, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant