📝 Find and fix all your project's typos with a single command!
rspell.mp4
rspell is a CLI tool that leverages cspell to find all the
typos in your project. It then uses an intuitive TUI so you can fix them without ever leaving your terminal. This is a
great way to tidy up your own code/documentation, or to contribute to your favorite open source projects!
You can install rspell through npm (requires Node.js 16.6.0 or higher):
npm i -g rspellOr, download a compiled binary from the latest release.
Usage: rspell [options] [files...]
📝 Find and fix all your project's typos with a single command!
Examples:
$ rspell Check all files
$ rspell "src/**/*.ts" Check all TypeScript files in the src directory
$ rspell --config some-file.json Use a custom configuration file
$ rspell "test" --exclude "**/__snapshots__/**" Exclude files in the __snapshots__ directory
Arguments:
files The glob patterns describing the files you want to spell check. (default: ["**"])
Options:
-V, --version output the version number
-c, --config <cspell.json> Configuration file to use. By default cspell looks for cspell.json in the current directory.
-e, --exclude <globs...> Exclude files matching the glob pattern.
-g, --use-gitignore Use the .gitignore file to exclude files.
-C, --cache Store the info about processed files in order to only operate on the changed ones.
-d, --dot Include files/directories starting with "." in the glob search.
-l, --locale <locale> Explicitly set the locale to use for spell checking.
-h, --help display help for command
Since rspell is built on top of cspell, you can customize the behavior of the tool by creating a cspell.json
file. If you don't have one, rspell will automatically create a config file for
you and update the list of ignored words appropriately as you use the CLI.
- mui/material-ui#36194 (980 typos)
- botlabs-gg/yagpdb#1438 (910 typos)
- PowerShell/PowerShell#19175 (881 typos)
- BabylonJS/Babylon.js/13571 (639 typos)
- strapi/strapi#15903 (483 typos)
- twitter/the-algorithm#1736 (437 typos)
- Byron/gitoxide#724 (408 typos)
- babel/babel#15432 (387 typos)
- flutter/flutter#121171 (284 typos)
- vercel/next.js#46281(197 typos)
- ant-design/ant-design#40791 (157 typos)
- pubkey/rxdb#4463 (156 typos)
- meilisearch/meilisearch#3512 (111 typos)
- SergioBenitez/Rocket#2471 (84 typos)
- nextauthjs/next-auth#6701 (63 typos)
- nestjs/nest#11096 (56 typos)
- vitest-dev/vitest#2815 (48 typos)
- TheAlgorithms/JavaScript#1283 (47 typos)
- Cog-Creators/Red-DiscordBot#5989 (43 typos)
- prisma/prisma#17874 (43 typos)
- trpc/trpc#3735 (40 typos)
- reactjs/reactjs.org#5586 (35 typos)
- zloirock/core-js#1215 (28 typos)
- nuxt/nuxt#18976 (26 typos)
- chakra-ui/chakra-ui#7340 (16 typos)
- nextjs/docs.nestjs.com#2622 (14 typos)
- solidjs/solid#1569 (14 typos)
- eslint/eslint#16884 (13 typos)
- discordjs/discord.js#9127 (12 typos)
- vuejs/core (9 typos)
- sveltejs/svelte#8257 (9 typos)
- crxjs/chrome-extension-tools#646 (8 typos)
- vitejs/vite#12032 (8 typos)
- rust-lang-nursery/rust-cookbook#684 (7 typos)
- arc53/DocsGPT#36 (5 typos)
- rust-secure-code/cargo-geiger#442 (4 typos)
- actix/actix-web#2982 (4 typos)
- graphile/worker#316 (2 typos)
- meilisearch/documentation#2177 (1 typo)
