Skip to content

Add codespell support (config, workflow to detect/not fix) and make it fix few typos#76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
yarikoptic wants to merge 3 commits into
base:main
Choose a base branch
from
Open

Add codespell support (config, workflow to detect/not fix) and make it fix few typos #76

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
110f476
Add GitHub Actions workflow for codespell on main
yarikoptic Aug 21, 2026
6b790b5
Add rudimentary codespell config
yarikoptic Aug 21, 2026
02b272e
[DATALAD RUNCMD] chore: run codespell throughout fixing few left typo…
yarikoptic Aug 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions .github/workflows/codespell.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
# Codespell configuration is within pyproject.toml
---
name: Codespell

on:
push:
branches: [main]
pull_request:
branches: [main]

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
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -101,7 +101,7 @@ CHANGELOG

## 0.1.2 (2024-03-20)

- Fix minimum required Pyhton version (3.11)
- Fix minimum required Python version (3.11)

## 0.1.0 (2024-03-18)

Expand Down
7 changes: 7 additions & 0 deletions pyproject.toml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,3 +51,10 @@ test = "python -m unittest -v"

[[tool.hatch.envs.test.matrix]]
python = ["3.9", "3.10", "3.11", "3.12", "3.13"]

[tool.codespell]
# Ref: https://github.com/codespell-project/codespell#using-a-config-file
skip = '.git,.gitignore,.gitattributes'
check-hidden = true
# ignore-regex = ''
# ignore-words-list = ''