Skip to content
This repository has been archived by the owner on Nov 30, 2023. It is now read-only.

Commit

Permalink
.vscode/devContainer.json => .devcontainer/devcontainer.json
Browse files Browse the repository at this point in the history
  • Loading branch information
Chuxel committed Apr 3, 2019
1 parent 284c16d commit 0e2cce5
Show file tree
Hide file tree
Showing 67 changed files with 12 additions and 101 deletions.
7 changes: 3 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,17 +100,16 @@ If you want to create a new definition:

```
📁 <language>-<optional: version>-<descriptor>
📁 .vscode
📄 devContainer.json
📁 .devcontainer
📄 devcontainer.json
📄 Dockerfile (optional)
📄 docker-compose.yml (optional)
📄 ignore
📁 test-project (optional)
📄 README.md
```

See the [VS Code Remote Development documentation](https://aka.ms/vscode-remote/docker) for information on the expected contents of `devContainer.json` and how it relates to other files listed above.
See the [VS Code Remote Development documentation](https://aka.ms/vscode-remote/docker) for information on the expected contents of `devcontainer.json` and how it relates to other files listed above.

Note that any additional assets can be included as needed, but keep in mind that these will overlay on top of an existing project. Keeping these files in the `.devcontainer` should reduce the chances of something conflicting but note that any command that are run are relative to the root of the project, so you'll need to include `.devcontainer` in any path references.

Expand All @@ -136,7 +135,7 @@ Finally, after you get your container up and running, you can test it by adding

While using a `Dockerfile` is a convienent way to get going with a new container definition, this method can slow down the process of creating the dev container since it requires the image be built by anyone using it. If your definition is stable, we strongly reccomend building and publishing your image to [DockerHub](https://hub.docker.com) or [Azure Container Registry](https://azure.microsoft.com/en-us/services/container-registry/) instead.

Once you've published your container image, just update `devContainer.json` to reference the image instead of the `Dockerfile`. See `container-templates/image` for an example.
Once you've published your container image, just update `devcontainer.json` to reference the image instead of the `Dockerfile`. See `container-templates/image` for an example.

## Contributing to Documentation

Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Visual Studio Code Remote allows you to open any folder inside (or mounted into)

**[See here to learn more about VS Code Remote](https://aka.ms/vscode-remote/containers)**.

This repository contains a set of **dev container definitions** made up of files like `devContainer.json` to help get you up and running in a containerized environment. These definitions describe the needed container image, any runtime arguments for starting the container, and any VS Code extensions that should be installed into it.
This repository contains a set of **dev container definitions** made up of files like `devcontainer.json` to help get you up and running in a containerized environment. These definitions describe the needed container image, any runtime arguments for starting the container, and any VS Code extensions that should be installed into it.

## Trying a definition

Expand All @@ -24,15 +24,15 @@ You can either:

- Run **Remote: Create Container Configuration File...** command in VS Code and pick a definition. The appropriate files will then be added to your project.

- Manually copy the contents of one of the `containers` sub-folders into your project. Copy the `.devcontainer` folder and `.vscode/devContainer.json` into your project and you should be ready to go!
- Manually copy the contents of one of the `containers` sub-folders into your project. Copy the `.devcontainer` folder into your project and you should be ready to go!

### Can I just reuse an existing Docker configuration?

Absolutely! If you want to use an existing Dockerfile as a starting point, run **Remote-Containers: Create Container Configuration File...** from the command pallette (Cmd/Ctrl+Shift+P). You'll be prompted to select a Dockerfile or you can opt to use a base image instead.

#### About `.vscode/devContainer.json`
#### About `.devcontainer/devcontainer.json`

The intent of `devContainer.json` is conceptually similar to VS Code's `launch.json` for debugging, but designed to launch (or attach to) your development container instead. At its simplest, all you need to do is add a `.vscode/devContainer.json` file to your project and reference an image, `Dockerfile`, or `docker-compose.yml`.
The intent of `devcontainer.json` is conceptually similar to VS Code's `launch.json` for debugging, but designed to launch (or attach to) your development container instead. At its simplest, all you need to do is add a `.devcontainer/devcontainer.json` file to your project and reference an image, `Dockerfile`, or `docker-compose.yml`.

Since you are here, check out the [existing Dockerfile](containers/docker-existing-dockerfile) and [existing Docker Compose](containers/docker-existing-docker-compose) definitions for details, but here's the a quick tour of the basic properties. If you have a `Dockerfile`, set these properties:

Expand All @@ -43,7 +43,7 @@ Since you are here, check out the [existing Dockerfile](containers/docker-existi
}
```

For Docker Compose, you can [attach to an already running container](https://aka.ms/vscode-remote/containers/attach) or configure `.vscode/devContainer.json` with these properties:
For Docker Compose, you can [attach to an already running container](https://aka.ms/vscode-remote/containers/attach) or configure `.devcontainer/devcontainer.json` with these properties:

```json
{
Expand All @@ -60,7 +60,7 @@ The other definitions in the `containers` folder will provide examples of how to

## Adding a definition to an existing public or private repo

You can easily share a customized dev container definition for your project by simply adding files like `.vscode/devContainer.json` to source control. By including these files in your repository, anyone that opens a local copy of your repo in VS Code will be automatically asked if they want reopen the folder in a container instead if the [Remote Development](https://aka.ms/vscode-remote/download/extension) extension installed.
You can easily share a customized dev container definition for your project by simply adding files like `.devcontainer/devcontainer.json` to source control. By including these files in your repository, anyone that opens a local copy of your repo in VS Code will be automatically asked if they want reopen the folder in a container instead if the [Remote Development](https://aka.ms/vscode-remote/download/extension) extension installed.

Beyond the advantages of having your team use a consistent environment and tool-chain, doing this can make it easier for new contributors or team members to get productive quickly. First-time contributors will require less guidance and are less likely to either submit issues or contribute code with issues that are related to environment setup.

Expand Down
2 changes: 0 additions & 2 deletions containers/azure-cli/.devcontainer/ignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
README.md
test-project
.vscode
!.vscode/devContainer.json
!.vscode/devcontainer.json
2 changes: 0 additions & 2 deletions containers/azure-functions-node-8/.devcontainer/ignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
README.md
test-project
.vscode
!.vscode/devContainer.json
!.vscode/devcontainer.json
2 changes: 0 additions & 2 deletions containers/azure-hdinsight-python-3/.devcontainer/ignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
README.md
test-project
.vscode
!.vscode/devContainer.json
!.vscode/devcontainer.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
README.md
test-project
.vscode
!.vscode/devContainer.json
!.vscode/devcontainer.json

This file was deleted.

2 changes: 0 additions & 2 deletions containers/azure-terraform/.devcontainer/ignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
README.md
test-project
.vscode
!.vscode/devContainer.json
!.vscode/devcontainer.json
2 changes: 0 additions & 2 deletions containers/cpp/.devcontainer/ignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
README.md
test-project
.vscode
!.vscode/devContainer.json
!.vscode/devcontainer.json
2 changes: 0 additions & 2 deletions containers/dart-web/.devcontainer/ignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
README.md
test-project
.vscode
!.vscode/devContainer.json
!.vscode/devcontainer.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
README.md
test-project
.vscode
!.vscode/devContainer.json
!.vscode/devcontainer.json
2 changes: 0 additions & 2 deletions containers/docker-existing-dockerfile/.devcontainer/ignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
README.md
test-project
.vscode
!.vscode/devContainer.json
!.vscode/devcontainer.json
2 changes: 0 additions & 2 deletions containers/docker-in-docker-compose/.devcontainer/ignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
README.md
test-project
.vscode
!.vscode/devContainer.json
!.vscode/devcontainer.json
2 changes: 0 additions & 2 deletions containers/docker-in-docker/.devcontainer/ignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
README.md
test-project
.vscode
!.vscode/devContainer.json
!.vscode/devcontainer.json
2 changes: 0 additions & 2 deletions containers/dotnetcore-2.2-fsharp/.devcontainer/ignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
README.md
test-project
.vscode
!.vscode/devContainer.json
!.vscode/devcontainer.json
2 changes: 0 additions & 2 deletions containers/dotnetcore-2.2/.devcontainer/ignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
README.md
test-project
.vscode
!.vscode/devContainer.json
!.vscode/devcontainer.json
2 changes: 0 additions & 2 deletions containers/go/.devcontainer/ignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
README.md
test-project
.vscode
!.vscode/devContainer.json
!.vscode/devcontainer.json
2 changes: 0 additions & 2 deletions containers/java-8-maven/.devcontainer/ignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
README.md
test-project
.vscode
!.vscode/devContainer.json
!.vscode/devcontainer.json
2 changes: 0 additions & 2 deletions containers/javascript-node-8-mongo/.devcontainer/ignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
README.md
test-project
.vscode
!.vscode/devContainer.json
!.vscode/devcontainer.json
2 changes: 0 additions & 2 deletions containers/javascript-node-8/.devcontainer/ignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
README.md
test-project
.vscode
!.vscode/devContainer.json
!.vscode/devcontainer.json
2 changes: 0 additions & 2 deletions containers/kubernetes-helm/.devcontainer/ignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
README.md
test-project
.vscode
!.vscode/devContainer.json
!.vscode/devcontainer.json
5 changes: 0 additions & 5 deletions containers/latex/.devcontainer/ignore

This file was deleted.

7 changes: 0 additions & 7 deletions containers/latex/.vscode/devContainer.json

This file was deleted.

5 changes: 0 additions & 5 deletions containers/latex/README.md

This file was deleted.

2 changes: 0 additions & 2 deletions containers/markdown/.devcontainer/ignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
README.md
test-project
.vscode
!.vscode/devContainer.json
!.vscode/devcontainer.json
2 changes: 0 additions & 2 deletions containers/php-7/.devcontainer/ignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
README.md
test-project
.vscode
!.vscode/devContainer.json
!.vscode/devcontainer.json
2 changes: 0 additions & 2 deletions containers/plantuml/.devcontainer/ignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
README.md
test-project
.vscode
!.vscode/devContainer.json
!.vscode/devcontainer.json
2 changes: 0 additions & 2 deletions containers/powershell/.devcontainer/ignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
README.md
test-project
.vscode
!.vscode/devContainer.json
!.vscode/devcontainer.json
2 changes: 0 additions & 2 deletions containers/python-2/.devcontainer/ignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
README.md
test-project
.vscode
!.vscode/devContainer.json
!.vscode/devcontainer.json
2 changes: 0 additions & 2 deletions containers/python-3-django/.devcontainer/ignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
README.md
test-project
.vscode
!.vscode/devContainer.json
!.vscode/devcontainer.json
2 changes: 0 additions & 2 deletions containers/python-3-flask-redis/.devcontainer/ignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
README.md
test-project
.vscode
!.vscode/devContainer.json
!.vscode/devcontainer.json
2 changes: 0 additions & 2 deletions containers/python-3-jupyter-pyspark/.devcontainer/ignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
README.md
test-project
.vscode
!.vscode/devContainer.json
!.vscode/devcontainer.json
2 changes: 0 additions & 2 deletions containers/python-3/.devcontainer/ignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
README.md
test-project
.vscode
!.vscode/devContainer.json
!.vscode/devcontainer.json
2 changes: 0 additions & 2 deletions containers/ruby-2/.devcontainer/ignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
README.md
test-project
.vscode
!.vscode/devContainer.json
!.vscode/devcontainer.json
2 changes: 0 additions & 2 deletions containers/rust/.devcontainer/ignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
README.md
test-project
.vscode
!.vscode/devContainer.json
!.vscode/devcontainer.json
9 changes: 3 additions & 6 deletions containers/swift-4/.devcontainer/ignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
../README.md
../test-project
../.vscode/launch.json
../.vscode/launch.test.json
../.vscode/settings.json
../.vscode/tasks.json
README.md
test-project
.vscode
2 changes: 0 additions & 2 deletions containers/typescript-node-8/.devcontainer/ignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
README.md
test-project
.vscode
!.vscode/devContainer.json
!.vscode/devcontainer.json

0 comments on commit 0e2cce5

Please sign in to comment.