Skip to content

nguyencuong382/vell

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Vell

A tool for spell checking multiple files in a folder. Sometimes when you write a document for your project but you get misspelled words you don't know

Getting Started

Installing

pip install --upgrade vell

Check spell

  1. Create vell.ini config file based on vell.sample.ini
  2. Run the bellow command to check spell:
vell

Check spell on a specific folder

vell ./test

Custom vell.ini config file

Some misspelled words like 'my_var' are your definition and they appear many times, you can ignore them by theirs frequency of appearance In this case. I tell to vell if a word appears more than 5 times, it will be ignored

[spell]
level_ignore = 5

Vell checks multiple files with specific extensions. To add more type of files:

[spell]
extensions =
    .html,
    .rst,
    README.md,

Some misspelled words like html, env are keywords, you can ignore them when checking spell

[spell]
ignore_words =
    ; code
    html

    ; environment
    env

To exclude paths you don't want vell to check spell:

[path]
exclude =
    .env,
    .vscode,
    __pycache__,

About

Spell check for multiple files in a folder

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages