Skip to content

πŸ‘· Setup GH actions workflow to check sources for typos#160

Merged
savannahostrowski merged 4 commits into
mainfrom
typos
Jun 4, 2026
Merged

πŸ‘· Setup GH actions workflow to check sources for typos#160
savannahostrowski merged 4 commits into
mainfrom
typos

Conversation

@YuriiMotov

@YuriiMotov YuriiMotov commented Jun 3, 2026

Copy link
Copy Markdown
Member

Set up GH actions workflow to catch typos in sources.

In other repos we use it as pre-commit hook (see fastapi/fastapi#15482), but here we don't have prek, so I think GH action will be fine


Checked by introducing typo in 9028c1b:

image image

@YuriiMotov YuriiMotov marked this pull request as draft June 3, 2026 19:18
Comment thread .github/workflows/typos.yml Fixed
@YuriiMotov YuriiMotov changed the title πŸ‘· Setup workflow to check for typos πŸ‘· Setup workflow to chek for typos Jun 3, 2026
@YuriiMotov YuriiMotov changed the title πŸ‘· Setup workflow to chek for typos πŸ‘· Setup GH actions workflow to check sources and PR title for typos Jun 3, 2026
@YuriiMotov YuriiMotov changed the title πŸ‘· Setup GH actions workflow to check sources and PR title for typos πŸ‘· Setup GH actions workflow to check sources for typos Jun 3, 2026
@YuriiMotov YuriiMotov marked this pull request as ready for review June 3, 2026 20:14

@savannahostrowski savannahostrowski left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yeah, I went with Husky here rather than pre-commit/prek since this repo is node-only. Husky installs automatically with bun install and there's no second toolchain for contributors.

I tested and we could layer a soft typos check into the Husky pre-commit hook which runs typos only if the CLI is on PATH, and skips with an install hint otherwise. So no hard local dependency, but anyone who's brew installed typos-cli gets the check at commit time.

@YuriiMotov

Copy link
Copy Markdown
Member Author

I tested and we could layer a soft typos check into the Husky pre-commit hook which runs typos only if the CLI is on PATH, and skips with an install hint otherwise. So no hard local dependency, but anyone who's brew installed typos-cli gets the check at commit time.

But this way, it won't run in CI, right? I think checking it in CI is more important, but you can decide πŸ™‚

@savannahostrowski

Copy link
Copy Markdown
Member

Right, I'm saying, we should have this but perhaps also consider having this run locally on commit, optionally, if the user has the CLI installed.

@savannahostrowski savannahostrowski merged commit 4f1f951 into main Jun 4, 2026
9 checks passed
@savannahostrowski savannahostrowski deleted the typos branch June 4, 2026 17:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants