jupyterlab-vimrc

向jupyterlab添加基本的vimrc并支持将内容复制到系统剪贴板。

我还推荐

• https://github.com/axelfahy/jupyterlab-vim (笔记本中的vim)
• https://github.com/ianhi/jupyterlab_vim-system-clipboard-support (将内容复制到+或*寄存器) (现在包含在此扩展中！)

安装

# for jlab 3+
pip install jupyterlab-vimrc

或者对于jupyterlab=2

jupyter labextension install jupyterlab-vimrc@0.3.0

基本用法

您可以通过使用设置 > 高级设置编辑器 (Ctrl+,) 编辑设置来修改此伪vimrc的内容。命令定义为具有以下语法的数组：[lhs, rhs]。例如，您可以通过以下方式将 ii 映射到插入模式中的 <Esc>：

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

请参阅示例以获取其他预制的设置文件，例如 hjkl -> jkl;

支持的命令

目前支持以下命令

imap
nmap
vmap
inoremap*
nnoremap*
vnoremap*

* noremap 注意事项

noremap 命令也是可用的，但有一些注意事项

codemirror/keymap/vim.js 中 noremap 函数的注释说如下

非递归映射函数。
注意：这不会创建到默认键映射中不存在的键映射。请查看函数下方的 TODO。

我阅读了这段注释并查看了实际函数，我认为这些限制是

1. 映射的右侧必须在 默认 vim.js 键映射 中定义
2. 默认键映射不能是 [Ex to Ex] 或 [Key to Key] 映射。

结果将是您已经更改了默认键映射的 lhs，但其他什么也没有改变。如果您的映射不符合这些条件，则映射将不会执行，并且此扩展将在控制台输出错误信息。因此，您最好使用 map 命令并小心避免陷入无限映射循环。

要求

• 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)

贡献

开发安装

注意：您将需要 NodeJS 来构建扩展包。

conda install -c conda-forge nodejs

jlpm 命令是 JupyterLab 附带的 yarn 版本，它随 JupyterLab 一起安装。您可以使用 yarn 或 npm 替代下面的 jlpm。

# 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

您可以在不同的终端中同时监视源目录并运行 JupyterLab，以便监视扩展的源代码更改并自动重新构建扩展。

# Watch the source directory in one terminal, automatically rebuilding when needed
jlpm run watch
# Run JupyterLab in another terminal
jupyter lab

在运行监视命令时，每个保存的更改都将立即在本地构建并可供运行的 JupyterLab 使用。刷新 JupyterLab 以在浏览器中加载更改（您可能需要等待几秒钟，以便重新构建扩展）。

卸载

pip uninstall jupyterlab-vimrc
jupyter labextension uninstall jupyterlab-vimrc