Skip to content

Latest commit

 

History

History
100 lines (82 loc) · 5.88 KB

README.md

File metadata and controls

100 lines (82 loc) · 5.88 KB
Raw

rspell

GitHub Workflow Status License

📝 Find and fix all your project's typos with a single command!

rspell.mp4

📝 Description

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!

📦 Installation

You can install rspell through npm (requires Node.js 16.6.0 or higher):

npm i -g rspell

Or, download a compiled binary from the latest release.

🚀 Usage

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.

💡 Featured PRs using rspell