https://github.com/zimbatm/vscode-devcontainer-nix

WIP: VSCode remote container for Nix-based environments
https://github.com/zimbatm/vscode-devcontainer-nix

devcontainer nix vscode

Last synced: 3 months ago
JSON representation

WIP: VSCode remote container for Nix-based environments

• Host: GitHub
• URL: https://github.com/zimbatm/vscode-devcontainer-nix
• Owner: zimbatm
• License: apache-2.0
• Created: 2019-12-07T17:09:15.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-12-15T17:33:31.000Z (about 1 year ago)
• Last Synced: 2024-10-04T16:28:13.641Z (4 months ago)
• Topics: devcontainer, nix, vscode
• Language: Dockerfile
• Size: 20.5 KB
• Stars: 12
• Watchers: 5
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# vscode-devcontainer-nix

**STATUS: alpha**

For colleagues who insist on working on macOS and Windows. Even though all the

binaries are built for, deployed and executed on Linux servers.

[Visual Studio Core Remote - Containers](https://code.visualstudio.com/docs/remote/containers)

is a feature that allows to create a docker-based development environment.

VSCode will start the container and run all the commands inside of it.

This project's goal is to provide such container to work on Nix-based

projects.

## Usage

1. Install the [VSCode "Remote - Containers" plugin](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers)

2. Copy this repo under `.devcontainer` in the target project

Then VSCode would start the container and drop you into the nix-based

development environment.

## How it works

The VSCode plugin:

* looks for the .devcontainer folder

* builds the .devcontainer/Dockerfile

* starts the container

Then it uses uses `docker exec` to copy and install

supporting binaries into the container. This includes some bash scripts, a

node program, .... The binaries are compiled to work on Ubuntu which means

that /lib64/ld-linux-x86-64.so.2 must present, and a few other supporting

libraries.

It needs:

* a /tmp folder

* /bin/bash

* /bin/sh

* /usr/bin/env

* sed

* iproute

All of this is pre-built by the

[docker-nixpkgs](https://github.com/nix-community/docker-nixpkgs) project into

the nixpkgs/devcontainer image.

On Linux, the user must adjust the Dockerfile so that the UID and GID inside

of the container match the user UID and GID. It looks like this could be

automated. Right now there is this convention in the Dockerfile:

```

ARG USERNAME=vscode

ARG USER_UID=1000

ARG USER_GID=$USER_UID

```

I think vscode auto-detects the user UID and GID and injects them at build

time. To be confirmed.

## TODO

* startup nix-daemon --daemon in the background

* run `direnv allow .` once the container started

## Roadmap

1. [x] Make it work

2. [x] Pure nix-based docker container?

3. [ ] It would be nice if the vs extensions could be composed together.