nvim-remote-containers
nvim-remote-containers copied to clipboard
Develop inside docker containers, just like VSCode
NVIM-Remote-Containers
This plugin aims to give you the functionality of VSCode's remote container development plugin. It will allow you to spawn and develop in docker containers and pulls config information from a devcontainer.json
file.
Available Lua Functions
-
parseConfig
: parsesdevcontainer.json
file--takes in argument specifying type (dockerCompose, dockerFile, image) -
attachToContainer
: Attaches to a docker container or builds a container from a user chose image -
buildImage
: Builds container from the Dockerfile specified in thedevcontainer.json
file. Takes a boolean parameter to determine whether or not to show the build process in a floating window or in the quickfix list. -
composeUp
: Brings docker-compose up -
composeDown
: Brings docker-compose down -
composeDestroy
: Destorys docker-compose containers
Available Vim Commands
-
AttachToContainer
wrapper for theattachToContainer
lua function. -
BuildImage
wrapper for thebuildImage
lua function, takes "true" or "false" as an argument to decide whether or not to show the build progress in a floating window. -
StartImage
lists all available images and starts the one selected by you given the arguments found in thedevcontainer.json
file in your project's workspace. -
ComposeUp
wrapper forcomposeUp
lua function. -
ComposeDown
wrapper forcomposeDown
lua function. -
ComposeDestroy
wrapper forcomposeDestroy
lua function.
Extras
Set your statusline to reflect the current connected container through g:currentContainer
:
hi Container guifg=#BADA55 guibg=Black
set statusline+=%#Container#%{g:currentContainer}
Usage
If you are in the root directory that has the .devcontainer/
folder, you can run the following vim commands:
" If you haven't built the image specified in you config.
" Takes `true` or `false` depending on whether or not you want to see the build progress in a floating window.
:BuildImage
" Attach to the container you just built / a previously built container
:AttachToContainer
" Start a container from a pre-built image
:StartImage
" Runs the docker-compose -f <file> up
:ComposeUp
" Runs docker-compose -f <file> down
:ComposeDown
" Runs docker-compose rm <file> -fsv
:ComposeDestroy
Contributing
Lua code is formatted in a pre-commit hook using stylelua. Please install this as part of contributing to the project.