https://github.com/ss18/grep-typos
Quickly check your project for typos
https://github.com/ss18/grep-typos
grep grepping shell shell-script tools typos-check utility
Last synced: about 2 months ago
JSON representation
Quickly check your project for typos
- Host: GitHub
- URL: https://github.com/ss18/grep-typos
- Owner: ss18
- License: mit
- Created: 2017-10-14T23:09:49.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-02T09:13:46.000Z (over 2 years ago)
- Last Synced: 2025-03-10T06:06:51.274Z (3 months ago)
- Topics: grep, grepping, shell, shell-script, tools, typos-check, utility
- Language: Shell
- Homepage:
- Size: 3.01 MB
- Stars: 41
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
Quickly check your project for most common typos and misspellings.
## Usage
### Options
#### `--substrings`
Match substrings in searched text. This option will cause the script to use the data/typos.txt database. Default script behavior without the `--substrings` option is to match data/common_misspellings.txt against whole words only.
#### `--exclude=[EXCLUSIONS]`
Exclude specified files from processing.
### Example
`git clone [email protected]:ss18/grep-typos.git`
`cd grep-typos`
`./grep_typos.sh --substrings /Users/semenzhydenko/Projects/Private/PetProject`
## Contributing
1. [Fork this repository](https://github.com/ss18/grep-typos/fork)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. [Create a pull request](https://github.com/ss18/grep-typos/pull/new/master)
## License
Project is available under the MIT license. See the LICENSE file for more info.