Spell Checker for CI/CD

This project offers a straightforward method to establish a code spell checking CI job, utilising codespell to detect common spelling errors in your project's files. While codespell-project/actions-codespell is available, this project provides a more extensive approach in integratin the spell checking library into your project, including instructions for setting up and running codespell locally. You may also consider integrating a spell checking dependency like cspell with eslint. However, it has several limitations, for one, it does not support scanning markdown files.

Dependencies

• Python - high-level, general-purpose programming language
• pnpm - Fast, disk space efficient package manager. Can be installed with either npm or yarn
• codespell - Spell checker for source code. Has to be installed with pip

Usage

This project is built for a monorepo structure and uses a GitHub Action for running the checks. However, it can be adapted to other development styles and repository structures.

Setup

1. Move all the files and scripts in this repository to the repository of your project.
2. For further instructions, refer to tooling/codespell/docs/usage.md.

This will set up a GitHub Action that runs the spell checker on every push and pull request. The action will check all files in your repository, excluding certain directories and file types specified in the respective script and words in the ignore-these-words.txt.

Contributing

If you find any issues or have suggestions for improvements, feel free to open an issue or submit a pull request.