Giters

mikoto2000 / devcontainer.vim

VSCode Dev Container の Vim/NeoVim 版。 VSCode 向けに作成された devcontainer.json とは別に、後付け設定ファイルを追加するだけで Vim による Dev Container 開発が可能になることを目指しています。

Repository from Github https://github.commikoto2000/devcontainer.vimRepository from Github https://github.commikoto2000/devcontainer.vim

devcontainervimneovim

日本語 / English

devcontainer.vim

コンテナ上で Vim を使った開発をするためのツール。 (VSCode Dev Container の Vim 版)

VSCode 向けに作成された devcontainer.json に追加する形で Vim による Dev Container 開発のための設定を追加・起動するツールです。

Getting Started

Features:

  • 開発用コンテナを立ち上げ、そこに Vim/NeoVim を転送し、起動する
    • devcontainer.json が無いプロジェクトで、ワンショットで開発用コンテナを立ち上げる
      • docker に渡す引数のカスタマイズができる
    • devcontainer.json が無いプロジェクトに、devcontainer.json のテンプレートを追加できる
    • devcontainer.json があるプロジェクトで、開発用コンテナを開始・停止・削除できる
    • devcontainer.json とは別に、 devcontainer.vim.json を記述することで 開発用コンテナに devcontainer.vim 用の設定を追加できる
    • 開発用コンテナで起動する Vim に追加で設定する vimrc を定義できる
    • 開発コンテナ内に Vim/NeoVim のパスが通っている場合、それを利用する
  • 開発用コンテナ上の Vim でヤンクした文字列を、ホスト PC のクリップボードへ貼り付けられる
  • 開発用コンテナ内で使用するしたいツールを、開発用コンテナに転送して使用可能にする
  • vim, devcontainer, clipboard-data-receiver など、使用するツールのアップデートができる
  • セルフアップデートができる

Requirements:

以下コマンドがインストール済みで、PATH が通っていること。

  • docker

コンテナ内に以下コマンドが存在し、 PATH が通っていること。

  • which
  • hostname

ARM の場合、コンテナ内に tar コマンドが存在していること

Usage:

NAME:
   devcontainer.vim - devcontainer for vim.

USAGE:
   devcontainer.vim [global options] command [command options] 

VERSION:
   3.5.7

COMMANDS:
   run                 Run container use `docker run`
   templates           Run `devcontainer templates`
   start               Run `devcontainer up` and `devcontainer exec`
   stop                Stop devcontainers.
   down                Stop and remove devcontainers.
   config              devcontainer.vim's config information.
   vimrc               devcontainer.vim's vimrc information.
   runargs             run subcommand's default arguments.
   tool                Management tools
   clean               clean workspace cache files.
   index               Management dev container template index file
   self-update         Update devcontainer.vim itself
   bash-complete-func  Show bash complete func
   help, h             Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --license, -l  show licensesa.
   --nvim         use NeoVim.
   --shell value  start with shell.
   --help, -h     show help
   --version, -v  print the version

devcontainer.json が存在しないプロジェクトで、ワンショットで環境を立ち上げる

devcontainer.vim run [DOCKER_OPTIONS] [DOCKER_ARGS]

docker run -it --rm -v "$(pwd):/work" --workdir /work -v "$HOME/.vim:/root/.vim" --name golang golang:1.22.1-bookworm コマンド相当の環境でコンテナを立ち上げる場合の例:

devcontainer.vim run -v "$(pwd):/work" --workdir /work -v "$HOME/.vim:/root/.vim" --name golang golang:1.22.1-bookworm

devcontainer.json が存在する場合

環境の起動

start サブコマンドで、環境を立ち上げ、Vim を転送し、起動できる。

たとえば、カレントディレクトリから devcontainer.json を検索し、読み込み、環境を立ち上げ、Vim を転送し、起動する場合は以下。

devcontainer.vim start .

devcontainer への引数を(--workspace-folder 以外は) そのまま利用できるため、 .vim をバインドしたい場合、以下のように指定する。

devcontainer.vim start --mount "type=bind,source=$HOME/.vim,target=/root/.vim" .

環境の停止

stop サブコマンドで環境の停止ができる。

devcontainer.vim stop .

再開したい場合は、もう一度 start サブコマンドを実行する。

環境の削除

down サブコマンドで環境の削除ができる。

devcontainer.vim down .

ツールのアップデート

devcontainer.vim が内部で利用するツールをアップデートしたい場合には、 tool サブコマンドを使用する。

# Vim のアップデート
devcontainer.vim tool vim download

# devcontainer CLI のアップデート
devcontainer.vim tool devcontainer download

devcontainer.vim 自身のアップデート

self-update サブコマンドを使用して、 devcontainer.vim 自身を最新バージョンに更新できます。

devcontainer.vim self-update

テンプレートをもとに devcontainer.json を作成する

devcontainer.vim templates apply サブコマンドを使用することで、 devcontainers が提供しているテンプレートから devcontainer.json を生成できる。

Go のテンプレートを用いて devcontainer.json を生成する場合の例:

$ devcontainer.vim templates apply .
Search: Go
? Select Template: 
  ▸ Go
    Go & PostgreSQL
    Node.js & Mongo DB
    Hugo & pnpm

devcontainer.vim templates apply を実行すると、テンプレート名の一覧が表示されるので、キー入力で名前をインクリメンタル検索し、上下キーでカーソルを移動・エンターキーでテンプレートを決定できる。

サブコマンドの補完

devcontainer.vim にパスを通し、 .bashrc などに以下コードを追加することで、サブコマンドの補完が有効になります。

eval "$(devcontainer.vim bash-complete-func)"

Customize:

コンテナのカスタマイズ

.vim や vimfiles など、ホストからバインドマンとさせたいものがあるが、 VSCode 等の他ツール向けに作成した devcontainer.json に devcontainer.vim 専用の mounts 定義を付けることはしたくない。

そのため、別途 devcontainer.vim のみが読み込むファイルを .devcontainer/devcontainer.vim.json に配置する。 devcontainer.vim は、 .devcontainer/devcontainer.json と .devcontainer/devcontainer.vim.json をマージして実行する。

PROJECT_ROOT/
    +- .devcontainer/
    |   +- devcontainer.json      # 普通の devcontainer 向けの設定を記述
    |   +- devcontainer.vim.json  # .vim のマウントなど、 devcontainer.vim のみで利用したい設定を記述
    |
    +- ...(other project files)

devcontainer.json:

{
  "name":"Go",
  "image":"mcr.microsoft.com/devcontainers/go:1-1.22-bookworm",
  "features":{},
  "remoteUser":"vscode"
}

devcontainer.vim.json:

{
  "mounts": [
    {
      "type": "bind",
      "source": "${localEnv:HOME}/.vim",
      "target": "/home/vscode/.vim"
    }
  ]
}

追加の設定を生成する

devcontainer.vim config -g で devcontainer.vim が使用するための追加設定ファイルのテンプレートを生成できる。

devcontainer.vim config -g --home /home/containerUser > .devcontainer/devcontainer.vim.json

使用できるオプションは以下:

  • -g : 設定生成フラグ
  • -o : 生成した設定の出力先ファイルを指定(default: STDOUT)
  • --home : 設定テンプレート内のホームディレクトリのパス

追加のランタイムをコンテナへインストールする

denops.vim や coc.nvim など 別途ランタイムが必要なプラグインを使用している場合、 devcontainer.vim.json の features にイメージ ID を追加することで、コンテナへランタイムをインストールできる。

deno をコンテナにインストールする例:

...(snip)
  "features": {
    "ghcr.io/devcontainers-community/features/deno:1": {}
  }
...(snip)

features に指定できるイメージは Available Dev Container Features で確認できる。

Vim のカスタマイズ

devcontainer.vim 上の Vim にのみ読み込まれる vimrc の作成

devcontainer.vim vimrc -o で、コンテナ上で実行する Vim に、追加で読み込ませるスクリプトが開きます。

このスクリプトを更新することで、コンテナ上の Vim のみに適用させたい設定ができます。

デフォルトでは、以下の内容になっています。 (ノーマルモードで "*yy, ヴィジュアルモードで "*y でホストへ " レジスタの内容を送信する) 好みに応じて修正してください。

if !has("nvim")
  nnoremap <silent> "*yy yy:call SendToCdr('"')<CR>
  vnoremap <silent> "*y y:call SendToCdr('"')<CR>
else
  nnoremap <silent> "*yy yy:lua SendToCdr('"')<CR>
  vnoremap <silent> "*y y:lua SendToCdr('"')<CR>
endif

また、デフォルトに戻したい場合には、 -g オプションで vimrc を再生成してください。

devcontainer.vim vimrc -g

devcontainer.vim 上の Vim でのみ実行したい Vim script

devcontainer.vim 上で動く Vim には、 g:devcontainer_vim 変数が v:true で定義される。 以下のように判定すれば、「devcontainer.vim 上で動く Vim のみで実行される Vim script」が記述できる。

if get(g:, "devcontainer_vim", v:false)
  " Run only on devcontainer.vim
endif

run サブコマンドの引数のカスタマイズ

devcontainer.vim runargs -o で、 run サブコマンドへ暗黙的に設定される引数設定ファイルが開きます。

このファイルを更新することで、暗黙的に適用させたい引数が指定できます。

デフォルトでは、以下の内容になっています。 (カレントディレクトリを /work へマウントし、ワーキングディレクトリも同じ場所へ設定) 好みに応じて修正してください。

-v "$(pwd):/work" -v "$HOME/.vim:/root/.vim" --workdir /work

また、デフォルトに戻したい場合には、 -g オプションで runargs を再生成してください。

devcontainer.vim runargs -g

NeoVim の利用

「--nvim オプションを追加する」または、「環境変数 DEVCONTAINER_VIM_TYPE に nvim を設定する」 ことで、 vim の代わりに nvim の AppImage を転送して起動します。

devcontainer.vim --nvim start .

or

export DEVCONTAINER_VIM_TYPE=nvim
devcontainer.vim start .

シェルの利用

「--shell オプションを追加する」または、「環境変数 DEVCONTAINER_SHELL_TYPE に使用するシェルを設定する」 ことで、 vim の代わりにシェルを起動します。

devcontainer.vim --shell bash start .

or

export DEVCONTAINER_VIM_TYPE=bash
devcontainer.vim start .

その際に、転送した Vim/Neovim を使用したい場合には、/VimRun.sh を実行してください。

Migration:

x.x.x to 3.5.1

Docker Desktop を使用しない環境では、 host.docker.internal が使用できず、クリップボード連携が失敗していた。 start コマンドでは、それを回避するための設定を devcontainer.vim.json に追加しなければいけない。 v3.5.1 移行は、 config -g で生成されるひな形にコメントアウトした状態で記載されているが、 v3.5.1 よりもまえに生成した vim.json の場合、以下設定を追記してください。

これを追記することにより、 host.docker.internal が使えるようになり、クリップボード連携も正しく機能します。

  "runArgs": [
    "--add-host=host.docker.internal:host-gateway"
  ],

2.x.x to 3.x.x

devcontainer.vim 2.x.x で Vim を利用しており、devcontainer.vim 3.x.x から NeoVim を利用する場合、devcontainer.vim vimrc -o で表示される vimrc のマッピングを削除するか、以下のように if !has("nvim") でマッピングを囲むかの対応をしてください。

if !has("nvim")
  nnoremap <silent> "*yy yy:call SendToCdr('"')<CR>
  vnoremap <silent> "*y y:call SendToCdr('"')<CR>
endif

3.1.0 to 3.2.0

v3.2.0 から NeoVim でのクリップボード連携が使用可能となったため、 Vim/NeoVim 両方を使用する場合、vimrc を以下のように書き換えてください。

if !has("nvim")
  nnoremap <silent> "*yy yy:call SendToCdr('"')<CR>
  vnoremap <silent> "*y y:call SendToCdr('"')<CR>
else
  nnoremap <silent> "*yy yy:lua SendToCdr('"')<CR>
  vnoremap <silent> "*y y:lua SendToCdr('"')<CR>
endif

Limitation:

  • alpine 系のコンテナでは amd64 アーキテクチャは使用できません
  • aarch64 のコンテナで NeoVim を利用する場合はシステムインストールされたものを利用する必要があります
  • NeoVim AppImage が使えず、システムインストールの NeoVim も存在しない場合、 NeoVim の代わりに Vim が起動します
  • macOS で NeoVim を利用する場合は、システムインストールの NeoVim しか利用できません システムインストールの NeoVim が検出できなかった場合、代わりに Vim が起動します
  • WSL2 の docker を利用している場合、クリップボード連携が動きません
  • Docker Desktop で WSL2 Integration を利用している場合、 forwardPorts が上手く動かないため、 appPort を使用してください

Install:

binary download

Latest version

go install

go install github.com/mikoto2000/devcontainer.vim@latest

バージョン指定でインストールしたい場合には、以下コマンドでインストールする。 ※ 設定不備で、バージョン指定でインストールできるのは v3.0.2 以降のみとなっている

go install github.com/mikoto2000/devcontainer.vim/v3@3.0.2

Uninstall:

Windows

Delete executable file, config directory(~/AppData/Roaming/devcontainer.vim), and cache directory(~/AppData/Local/devcontainer.vim).

Remove-Item PATH_TO/devcontainer.vim.exe
Remove-Item -Recurse ~/AppData/Roaming/devcontainer.vim
Remove-Item -Recurse ~/AppData/Local/devcontainer.vim

Linux

Delete executable file, config directory(~/.config/devcontainer.vim), and cache directory(~/.cache/devcontainer.vim).

rm PATH_TO/devcontainer.vim
rm -rf ~/.config/devcontainer.vim
rm -rf ~/.cache/devcontainer.vim

MacOS

TODO:

License:

Copyright (C) 2024 mikoto2000

This software is released under the MIT License, see LICENSE

このソフトウェアは MIT ライセンスの下で公開されています。 LICENSE を参照してください。

Author:

mikoto2000 mikoto2000@gmail.com

About

VSCode Dev Container の Vim/NeoVim 版。 VSCode 向けに作成された devcontainer.json とは別に、後付け設定ファイルを追加するだけで Vim による Dev Container 開発が可能になることを目指しています。

devcontainervimneovim

License:MIT License

Languages

Language:Go 96.3%Language:Shell 1.9%Language:Makefile 1.7%Language:Vim Script 0.1%