はじめに
Dockerコンテナ内で開発環境を構築し共有することもできるDev Containersの利用方法についてです。
インストール
VSCodeの拡張機能からインストールします。
利用方法
設定ファイルの追加
まず、VSCodeで開いているフォルダにDevContainersで開くためのファイルを追加します。
Dev ContainersがインストールされているとVSCodeの左下にステータスバー項目が表示されます。
歯車マークの下にある><を選択し、開発コンテナー構成ファイルを追加を選択します。
すると、コンテナ構成の追加場所を聞かれます。git 等で共有したい場合はワークスペースに、共有しない場合はユーザーデータフォルダを選択しますが、始めはワークスペースに追加した方が分かり易いかと思います。
次にテンプレートを選択します。Node.js の開発に使うのであればNode.js & TypeScript等です。選んだテンプレートによってNodeのバージョンなどを質問されるかと思いますので適宜選択してください。
最後にインストールする追加機能を選択します。
これで.devcontainer/devcontainer.jsonが作成されます。
devcontainer.json
この時点で右下に表示されているコンテナーで再度開くを押すとコンテナが作成されVSCodeが開きますが、devcontainer.jsonを編集することで開発環境を編集できます。
リファレンスに各プロパティの説明がありますが、Dockerfileやdocker-compose.ymlを利用する場合のプロパティを載せておきます。
{
"name": "開発コンテナの名前",
// image を利用する場合
"image":"開発コンテナの作成に使用するコンテナレジストリ",
// Dockerfile を使用する場合
"build": {
"dockerfile": "Dockerfileへのパス"
},
// docker-composeを使用する場合
"dockerComposeFile":"docker-composeへのパス、配列で複数も可能",
"service":"docker-compose内のどのサービスが開発コンテナかを指定する",
"workspaceFolder":"開発コンテナに接続したときにVSCodeが開くフォルダ"
}