History

Kate Temkin c893a86e54 initial commit of template		2024-04-26 22:49:34 -06:00
..
CHANGELOG.md	initial commit of template	2024-04-26 22:49:34 -06:00
cspell-ext.json	initial commit of template	2024-04-26 22:49:34 -06:00
django.txt.gz	initial commit of template	2024-04-26 22:49:34 -06:00
LICENSE	initial commit of template	2024-04-26 22:49:34 -06:00
package.json	initial commit of template	2024-04-26 22:49:34 -06:00
README.md	initial commit of template	2024-04-26 22:49:34 -06:00

README.md

Cspell Django Dictionary

Django dictionary for cspell.

This is a pre-built dictionary for use with cspell.

Installation

Global Install and add to cspell global settings.

npm install -g @cspell/dict-django
cspell link add @cspell/dict-django

Uninstall from cspell

cspell link remove @cspell/dict-django

Manual Installation

The cspell-ext.json file in this package should be added to the import section in your cspell.json file.

{
    // …
    "import": ["@cspell/dict-django/cspell-ext.json"],
    // …
}

Updating

This dictionary is generated from django's official documentation index : https://docs.djangoproject.com/en/VERSION/genindex/. To update it, edit update.pyto match wanted django's VERSION, install requirements (requests and BeautifulSoup) and run the script :

pip install -r requirements.txt
python update.py

Building

Building is only necessary if you want to modify the contents of the dictionary. Note: Building will take a few minutes for large files.

npm run build

License

WTFPL