A JupyterLab extension highlighting misspelled words in markdown cells within notebooks and in the text files.
The extension provides (Hunspell) SCOWL dictionaries for:
- American, British, Canadian, and Australian English
- German (Germany, Austria, Switzerland)
and will also use the Hunspell dictionaries installed in known paths which vary by operating systems. If you use JupyterLab in a browser running on a different computer than the jupyter server, please note that the dictionaries need to be installed on the server machine.
You can add custom dictionary by placing Hunspell files it in
dictionaries folder in one of the
data locations as returned by:
The extension has been tested up to JupyterLab version 3.0.
For JupyterLab 3.x:
pip install jupyterlab-spellchecker
conda install -c conda-forge jupyterlab-spellchecker
For JupyterLab 2.x:
jupyter labextension install @ijmbarr/jupyterlab_spellchecker
Adding dictionaries - example
jupyter --paths looks like:
config: /home/your_name/.jupyter /usr/local/etc/jupyter /etc/jupyter data: /home/your_name/.local/share/jupyter /usr/local/share/jupyter /usr/share/jupyter runtime: /home/your_name/.local/share/jupyter/runtime
and you want to add Polish language, you would put
/home/your_name/.local/share/jupyter/dictionaries (you will need to create this folder), so that the final structure looks similar to:
/home/your_name/.local/share/jupyter ├── dictionaries │ ├── pl_PL.aff │ └── pl_PL.dic ├── kernels │ └── julia-1.5 │ ├── kernel.json │ ├── logo-32x32.png │ └── logo-64x64.png ├── nbconvert │ └── templates │ ├── html │ └── latex ├── nbsignatures.db ├── notebook_secret └── runtime
Where to get the dictionaries from?
Some good sources of dictionaries include:
- LibreOffice/dictionaries GitHub repository
- Chromium repository
- (if you know of any other quality resources please send a PR to add them here)
Note: You will need NodeJS to build the extension package.
jlpm command is JupyterLab's pinned version of
yarn that is installed with JupyterLab. You may use
npm in lieu of
# Clone the repo to your local environment # Change directory to the jupyterlab_spellchecker directory # Install package in development mode pip install -e . # Link your development version of the extension with JupyterLab jupyter labextension develop . --overwrite # Rebuild extension Typescript source after making changes jlpm run build pip install pytest
You can watch the source directory and run JupyterLab at the same time in different terminals to watch for changes in the extension's source and automatically rebuild the extension.
# Watch the source directory in one terminal, automatically rebuilding when needed jlpm run watch # Run JupyterLab in another terminal jupyter lab
Make sure that eslint passes:
jlpm run eslint:check
If there are any issues it might be possible to autofix them with:
jlpm run eslint
python -m pytest