Skip to main content

Check spell for mutiple files in a project

Project description

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 bello command to check spell:
vell

Check spell on specific folder

vell ./test

Custom vell.ini config file

Some misspelled words like 'my_var' are your definition and they appear many time, you can ignore them by theirs frequency of appearance In this case. I tell to vell if a word appear more than 5 times, they 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]
...
ignore_words =
        ; code
        html

        ; environment
        env
...

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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

vell-1.0.4-py3-none-any.whl (5.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page