• Stars
    star
    205
  • Rank 191,264 (Top 4 %)
  • Language
    TypeScript
  • License
    BSD 3-Clause "New...
  • Created over 6 years ago
  • Updated about 1 year ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Spellchecker for JupyterLab notebook markdown cells and file editor.

jupyterlab-spellchecker

Extension status Github Actions Status Binder PyPI version Conda version

A JupyterLab extension highlighting misspelled words in markdown cells within notebooks and in the text files.

The JupyterLab extension is based on the spellchecker Jupyter Notebook extension and relies on Typo.js for the actual spell checking. Spellchecker suggestions are available from the context menu. The style of the highlights can be customized in the Advanced Settings Editor.

You can click on the status bar item to:

  • change language
  • enable spelling in the current document

Spellchecking in comments and strings in code can be configured in settings.

The extension provides (Hunspell) SCOWL dictionaries for:

  • American, British, Canadian, and Australian English
  • French,
  • German (Germany, Austria, Switzerland)
  • Portuguese,
  • Spanish

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:

jupyter --paths

You should place two files with extensions .aff and .dic, and name following BCP 47 standards. For more details, please see the example below.

JupyterLab Version

The extension has been tested up to JupyterLab version 4.0.

Installation

For JupyterLab 3.x and 4.x:

pip install jupyterlab-spellchecker

or

conda install -c conda-forge jupyterlab-spellchecker

For JupyterLab 2.x:

jupyter labextension install @ijmbarr/jupyterlab_spellchecker

Adding dictionaries - example

If 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 pl_PL.aff and pl_PL.dic in /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:

Using online dictionaries

An 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 to Advanced Settings Editor → Spellchecker and set onlineDictionaries to 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"
  }
]

Contributing

Development install

Note: You will need NodeJS to build the extension package.

The jlpm command is JupyterLab's pinned version of yarn that is installed with JupyterLab. You may use yarn or npm in lieu of jlpm below.

# 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

Before commit

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

Run tests:

python -m pytest

More Repositories

1

jupyterlab-variableInspector

Variable Inspector extension for Jupyterlab
TypeScript
1,096
star
2

jupyterlab_code_formatter

A JupyterLab plugin to facilitate invocation of code formatters.
Python
833
star
3

jupyterlab-vim

Vim notebook cell bindings for JupyterLab
TypeScript
667
star
4

rise

RISE: "Live" Reveal.js JupyterLab Slideshow Extension
TypeScript
167
star
5

jupyterlab-spreadsheet-editor

JupyterLab spreadsheet editor for tabular data (e.g. csv, tsv)
TypeScript
130
star
6

jupyterlab-topbar

JupyterLab Top Bar extensions
TypeScript
106
star
7

jupyterlab-kernelspy

A Jupyter Lab extension for inspecting messages to/from a kernel
TypeScript
81
star
8

jupyterlab-quickopen

Quickly open a file in JupyterLab by typing part of its name
TypeScript
81
star
9

jupyterlab-unfold

An IDE-like file browser for JupyterLab
TypeScript
80
star
10

jupyter-archive

A Jupyter/Jupyterlab extension to make, download and extract archive files.
Python
76
star
11

jupyter-videochat

Video chat with peers inside JupyterLab
TypeScript
60
star
12

jupyterlab-tour

A JupyterLab UI tour built on jupyterlab-tutorial and react-joyride.
TypeScript
59
star
13

jupyterlab-link-share

JupyterLab Extension to easily share a link to a running server on Binder
TypeScript
53
star
14

jupyterlab-contrib.github.io

Management and website of JupyterLab Unofficial Extensions and Tools
Smarty
41
star
15

jupyter-ui-toolkit

UI Toolkit for Jupyter
TypeScript
40
star
16

jupyterlab-cell-flash

JupyterLab extension to show a flash effect when a cell is executed ⚡ ✨
TypeScript
39
star
17

jlab-enhanced-cell-toolbar

A cell toolbar for JupyterLab.
TypeScript
39
star
18

jupyterlab-filesystem-access

[Experimental] Browse local files using the non-standard File System Access API
TypeScript
30
star
19

jlab-enhanced-launcher

Alternative launcher for JupyterLab
TypeScript
25
star
20

jupyterlab-app-cookiecutter

Kickstart your JupyterLab based standalone application 🚀
TypeScript
22
star
21

jupyterlab_toastify

Customize 'react-toastify' to integrate nicely in JupyterLab.
TypeScript
22
star
22

search-replace

Search and replace accross files
TypeScript
21
star
23

jupyterlab-theme-editor

Extension providing a theme editor where colors, font families and font sizes of the elements of the user interface can be varied
TypeScript
21
star
24

jupyterlab-favorites

Add the ability to save favorite folders to JupyterLab for quicker browsing
TypeScript
14
star
25

jupyterlab-open-url-parameter

JupyterLab extension to open files passed via a URL parameter.
TypeScript
10
star
26

jupyterlab-pytutor

Python Tutor extension for JupyterLab
TypeScript
9
star
27

jupyterlab-plugin-graph

JupyterLab extension to show an interactive dependency graph of the installed plugins
TypeScript
9
star
28

jupyterlab-fileopen

A JupyterLab extension that adds a shortcut for opening files using the OS file explorer
Python
7
star
29

jupyterlab-gitlab

A JupyterLab extension for browsing GitLab repositories
TypeScript
5
star
30

ipylgbst

A widget library for controlling LEGO® BOOST via web-bluetooth
Python
4
star
31

jlab-image-editor

Simple image editor for JupyterLab
TypeScript
4
star
32

jupyterlab-logout

Log out button for JupyterLab
Python
3
star
33

jupyterlab-code-toc

Table of Contents JupyterLab extension with code content
TypeScript
3
star
34

react-auth-google-example

Example enabling users to log in with Google Identity service for webapps.
TypeScript
1
star
35

jupyterlab-topbar-text

JupyterLab extension to display arbitrary text in the top bar
Python
1
star
36

.github

Health files for the @jupyterlab-contrib organization
1
star
37

jupyterlab-browser-storage

A JupyterLab Drive to save files in the browser storage.
TypeScript
1
star