Skip to main content
← Back to workflows

How to detect typos with GitHub Actions?

crate-ci/typos -
GitHub Action
v1.21.0
2,178
Contributors
Contributor - epage
Categories
CICUBE ANALYTICS INSIGHTS
Engineering Velocity: 25% Team Time Lost to CI Issues
View Platform →
3.5h
Time Saved/Dev/Week
40%
Faster Releases
Click for next insight
Usage
name: Test GitHub Action
on: [pull_request]
jobs:
run:
name: Spell Check with Typos
runs-on: ubuntu-latest
steps:
- name: Use custom config file
uses: crate-ci/typos@master
with:
files: ./file.txt
config: ./myconfig.toml

typos logo

typos

Source code spell checker


Typos-action is an action detecting and fixing source code misspellings. It's fast enough, so even in big repositories, it will be a great fit and is designed to make false positives to a minimum. So it can be run on pull requests reliably.

  • Handling False Positives: This will be pretty useful for both names or domain-specific language, thus making it relatively easy to modify its sensitivity by editing the typos.toml file to ignore some words or patterns. Integrations: It offers integrations with GitHub Actions, comes complete with pre-commit hooks, and even offers a Visual Studio Code extension.

It gives the commands to dump configurations or see certain components of your text for further debugging or customizing. You might even get output in different formats like JSON, such that you can process the data in other tools with ease.

This seems quite priceless to keep the quality of the code without burdening manual spell checking. This is very helpful, especially for such teams to work on huge codebases and open source contributions, where consistency in naming and documentation is key.