https://github.com/GustavoKatel/devcontainers-rs

Rust implementation of the VSCode devcontainer.json file
https://github.com/GustavoKatel/devcontainers-rs

Last synced: 3 months ago
JSON representation

Rust implementation of the VSCode devcontainer.json file

• Host: GitHub
• URL: https://github.com/GustavoKatel/devcontainers-rs
• Owner: GustavoKatel
• Created: 2020-10-17T14:41:39.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-01-22T18:36:09.000Z (almost 2 years ago)
• Last Synced: 2024-06-11T00:11:22.730Z (5 months ago)
• Language: Rust
• Size: 177 KB
• Stars: 16
• Watchers: 7
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# devcontainers-rs

For those who want to try out VSCode's devcontainers without VSCode.

This project is mostly aiming to bring the VSCode's remote development experience to neovim, but at

the end others editors/clients can be attached too.

Please refer to the devcontainer.json [reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference)

**⚠️ This is in active development and rapidly growing! Use at your own risk. And feel free to

play around and let me know in the issues what features you'd like to see here. ⚠️**

## Requirements

- docker

## HOW-TO

0- Run `devcontainers_rs -h` to see the available options.

1- Inside a directory containing the `.devcontainer` folder, run:

```bash

$ devcontainers_rs up

```

2- You can add custom settings to be applied to all projects in `$HOME/.config/devcontainer.json`

Available settings: `application` (object), `mounts` (object), `postCreateCommand` (string/array), `postStartCommand` (string/array), `postAttachCommand` (string/array), `forwardPorts` (array), `env` (object)

2.1 - Starting editor/ide after setting up containers:

```json

{

    ...

    "application": { "cmd": ["nvim-qt", "--server", "127.0.0.1:9797", "--nofork"] },

    "forwardPorts": [9797],

    "postAttachCommand": ["bash", "start-headless-nvim.sh"]

    ...

}

```

## FEATURES:

⚙️ - DOING

✅ - DONE

[✅] create containers based on image

[✅] spawn custom application

[✅] `postCreateCommand`, `postStartCommand`, `postAttachCommand`

[✅] `appPort`

[⚙️] `devPort`

[✅] `forwardPorts`

[ ] `initializeCommand`

[✅] create containers based on `build`

[✅] create containers from docker-compose

[✅] stop containers

[ ] destroy containers

[ ] user management (`remoteUser`,  `containerUser`, `updateRemoteUserUID`)