Skip to main content

add a basic vimrc to jupyterlab

Project description

jupyterlab-vimrc

Github Actions Status

add a basic vimrc to jupyterlab + support for yanking to the system clipboard.

I also recommend:

Install

# for jlab 3+
pip install jupyterlab-vimrc

or for jupyterlab=2

jupyter labextension install jupyterlab-vimrc@0.3.0

Basic Usage

You can modify the contents of this psuedo vimrc by editing the settings using Settings > Advanced Settings Editor (Ctrl+,) and selecting the settings for vimrc. Commands are defined as arrays with the syntax: [lhs, rhs]. For example you can map ii to <Esc> in insert mode by adding the following to the settings:

{
"imap": 
    [
        ["ii", "<Esc>"],
    ],
}

See the Examples for other premade settings files such as hjkl -> jkl;

Supported Commands

Currently supports these commands:

imap
nmap
vmap
inoremap*
nnoremap*
vnoremap*

* noremap caveat

The noremap commands are also availiable but come with several caveats:

The comment for the noremap function in codemirror/keymap/vim.js says the following:

Non-recursive map function.
NOTE: This will not create mappings to key maps that aren't present in the default key map. See TODO at bottom of function.

My reading of this comment and looking through the actual function leads me to believe that the restrictions are:

  1. The right hand side of the mapping must be defined in the default vim.js keymap
  2. The default keymap must not be an [Ex to Ex] or [Key to Key] mapping.

The result will then be that you have changed the lhs for the default keymapping but nothing else. If your mapping doesn't meet these conditions then the mapping will not be performed and this extension will put an error message in the console. So it may be in your best interest to just use the map commands and be careful to not get caught in infinite mapping loops.

Requirements

  • JupyterLab >= 3.0 (pip install jupyterlab-vimrc)
  • JupyterLab >= 2.0 (jupyter labextension install jupyterlab-vimrc@0.3.0)
  • JupyterLab >= 1.0 (jupyter labextension install jupyterlab-vimrc@jlab1)

Contributing

Development install

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

conda install -c conda-forge nodejs

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-vimrc 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

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

With the watch command running, every saved change will immediately be built locally and available in your running JupyterLab. Refresh JupyterLab to load the change in your browser (you may need to wait several seconds for the extension to be rebuilt).

Uninstall

pip uninstall jupyterlab-vimrc
jupyter labextension uninstall jupyterlab-vimrc

Project details


Download files

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

Source Distribution

jupyterlab-vimrc-0.5.2.tar.gz (13.4 kB view details)

Uploaded Source

Built Distribution

jupyterlab_vimrc-0.5.2-py3-none-any.whl (23.5 kB view details)

Uploaded Python 3

File details

Details for the file jupyterlab-vimrc-0.5.2.tar.gz.

File metadata

  • Download URL: jupyterlab-vimrc-0.5.2.tar.gz
  • Upload date:
  • Size: 13.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.0

File hashes

Hashes for jupyterlab-vimrc-0.5.2.tar.gz
Algorithm Hash digest
SHA256 f52b083c748f3a5ece56b509e2a5b7055686cde52fa75f9782deffbc60989cfa
MD5 a1bc16a237bee5dcc635a7d6d8838114
BLAKE2b-256 6991701aa1c28aa4c3a7a99a69e4d5ffd47f06b56d841f267e20977337dac0e4

See more details on using hashes here.

File details

Details for the file jupyterlab_vimrc-0.5.2-py3-none-any.whl.

File metadata

  • Download URL: jupyterlab_vimrc-0.5.2-py3-none-any.whl
  • Upload date:
  • Size: 23.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.9.0

File hashes

Hashes for jupyterlab_vimrc-0.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 3891af8169479f73362cf4167ae4485aee4a3be82369f7c4f23f45b586ebfff1
MD5 b9b648dead16bb52fa09deb2afbbd6d0
BLAKE2b-256 3c17cc7c3724cf5b5830009b355a343063f8ee7bb762555022c6b17ade44076c

See more details on using hashes here.

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