Package: jupyterlab-spellchecker
jupyterlab-spellcheckerA JupyterLab extension highlighting misspelled words in markdown cells within notebooks and in the text files.The JupyterLab extension is based onthe spellchecker Jupyter Notebook extensionand relies onTypo.jsfor the actual spell checking.
Spellchecker suggestions are available from the context menu. The style of the highlights can be customized in theAdvanced Settings Editor.You can click on the status bar item to:change languageenable spelling in the current documentSpellchecking in comments and strings in code can be configured in settings.The extension provides (Hunspell)SCOWLdictionaries for:American, British, Canadian, and Australian EnglishFrench,German (Germany, Austria, Switzerland)Portuguese,Spanishand will also use the Hunspell dictionaries installed inknown pathswhich 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 indictionariesfolder in one of thedatalocations as returned by:jupyter--pathsYou should place two files with extensions.affand.dic, and name followingBCP 47standards.
For more details, please see theexamplebelow.JupyterLab VersionThe extension has been tested up to JupyterLab version 4.0.InstallationFor JupyterLab 3.x and 4.x:pipinstalljupyterlab-spellcheckerorcondainstall-cconda-forgejupyterlab-spellcheckerFor JupyterLab 2.x:jupyterlabextensioninstall@ijmbarr/jupyterlab_spellcheckerAdding dictionaries - exampleIfjupyter --pathslooks 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/runtimeand you want to add Polish language, you would putpl_PL.affandpl_PL.dicin/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
└── runtimeWhere to get the dictionaries from?Some good sources of dictionaries include:LibreOffice/dictionariesGitHub repositoryChromiumrepository(if you know of any other quality resources please send a PR to add them here)Using online dictionariesAn alternative to saving the dictionary on your own disk (or more accurately on the disk where jupyter-server is set up)
is fetching the dictionaries from a remote URL. This requires an Internet connection to load the dictionary
(each time when you open JupyterLab or change the dictionary), and might be useful if you are not able
to save dictionaries on disk (e.g. when using JupyterLab on JupyterHub configured by someone else).To configure the online dictionaries go toAdvanced Settings Editor→Spellcheckerand setonlineDictionariesto an array of JSON objects like in the example below:[{"id":"en_US-online","aff":"https://cdn.jsdelivr.net/codemirror.spell-checker/latest/en_US.aff","dic":"https://cdn.jsdelivr.net/codemirror.spell-checker/latest/en_US.dic","name":"My favorite variant of English"}]ContributingDevelopment installNote: You will need NodeJS to build the extension package.Thejlpmcommand is JupyterLab's pinned version ofyarnthat is installed with JupyterLab. You may useyarnornpmin lieu ofjlpmbelow.# Clone the repo to your local environment# Change directory to the jupyterlab_spellchecker directory# Install package in development modepipinstall-e.# Link your development version of the extension with JupyterLabjupyterlabextensiondevelop.--overwrite# Rebuild extension Typescript source after making changesjlpmrunbuild
pipinstallpytestYou 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 neededjlpmrunwatch# Run JupyterLab in another terminaljupyterlabBefore commitMake sure that eslint passes:jlpmruneslint:checkIf there are any issues it might be possible to autofix them with:jlpmruneslintRun tests:python-mpytest