Skip to content

Add spell-checker to the CI #2660

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.

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
szabgab opened this issue Apr 10, 2025 · 0 comments
Open

Add spell-checker to the CI #2660

szabgab opened this issue Apr 10, 2025 · 0 comments
Labels
C-enhancement Category: Enhancement or feature request

Comments

@szabgab
Copy link
Contributor

szabgab commented Apr 10, 2025

Problem

Recently I made a typo #2658

To avoid such mistakes, I'd suggest to add a spell-check to the CI.

I saw this being used axum

On the command line run

cargo install typos-cli

typos --exclude "test_book/" --exclude "*.css" --exclude tests/summary_md_files/the_book-2nd_edition.md --exclude CHANGELOG.md --exclude tests/parse_existing_summary_files.rs --exclude src/front-end/fonts/fontawesome-webfont.svg --exclude src/front-end/searcher/elasticlunr.min.js --exclude ./src/front-end/playground_editor/ace.js --exclude src/front-end/playground_editor/ace.js --exclude src/front-end/js/highlight.js --exclude src/front-end/js/book.js --exclude src/preprocess/links.rs --exclude src/preprocess/links.rs --exclude src/book/book.rs --exclude src/renderer/html_handlebars/hbs_renderer.rs

Right now, using the above exclude list it does not complain. Some of those could be fix, others, like the 3rd-party js files, will have to permanently remain in the exclude list.

Proposed Solution

No response

Notes

No response

@szabgab szabgab added the C-enhancement Category: Enhancement or feature request label Apr 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-enhancement Category: Enhancement or feature request
Projects
None yet
Development

No branches or pull requests

1 participant