Skip to content

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

Open
yarikoptic wants to merge 5 commits intopaperwm:developfrom
yarikoptic:enh-codespell
Open

Add codespell support (config, workflow to detect/not fix) and make it fix some typos#1071
yarikoptic wants to merge 5 commits intopaperwm:developfrom
yarikoptic:enh-codespell

Conversation

@yarikoptic
Copy link
Collaborator

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.

Copy link
Member

@smichel17 smichel17 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The rest looks good

@yarikoptic
Copy link
Collaborator Author

should I rebase into develop?

PS FWIW, in some projects we eventually switched everywhere default branches to be the ones to seek PRs into to avoid hassle of needing to ask to rebase etc. Should may be develop to become the default branch to be cloned / sent PRs to?

@smichel17
Copy link
Member

Yes, all PRs should go to develop.

I wasn't involved with the decision to set up the branches how they are now (See CONTRIBUTING.md for history (it's short)). But release is the default to facilitate people who are obtaining paperwm from github instead of getting it through extensions.gnome.org (at one point during the transition to a community project, paperwm was not on extensions.gnome.org).

We could probably do a better job of handling the install process (I'd guide people to use the gnome-* branches instead of release. Personally I use a git worktree to install my running version, rather than the symlink that the install script creates. (Related: #1061)

@yarikoptic yarikoptic changed the base branch from release to develop January 26, 2026 19:18
yarikoptic and others added 4 commits January 26, 2026 14:21
Automated fixes applied by codespell -w.

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "uvx codespell -w",
 "exit": 65,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
Fixed typos that codespell detected but didn't auto-fix:
- extact → extract (extract all mods)
- initate → initiate (initiate visual destruction)
- troube → trouble (is trouble)
- essentiall → essentially (essentially disable)

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@yarikoptic
Copy link
Collaborator Author

re-based etc, might be ready for the prime time! ;-)

Copy link
Collaborator

@Thesola10 Thesola10 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks ready for prime time


# generated disk image for test VM
nixos.qcow2
.claude/
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sneaky ;)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

want me to filter it out?

check-hidden = true
# ignore-regex =
# initialY: variable name for initial Y coordinate
ignore-words-list = easer,positionOf,initialY
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good idea, but codespell-project/codespell#196 still not being implemented gives me pause as to the quality of codespell itself...

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh, if that was the only concern... all software is constant WiP / trove of skeletons etc... only visidata (or replace with paperwm if you like) is perfect! ;)

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FWIW -- I used codespell across HUNDREDS of projects with good return rate... here is some overview of state of my endavors on that end if you like to see more 'victims' of typos-less world of mine: https://github.com/yarikoptic/improveit-dashboard/blob/master/READMEs/yarikoptic.md

@Thesola10 Thesola10 requested a review from smichel17 January 28, 2026 11:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants