From e7b7340a885ed5ecbea7d4e7897b9083e3a09c6c Mon Sep 17 00:00:00 2001 From: Sander Maijers <3374183+sanmai-NL@users.noreply.github.com> Date: Mon, 16 Aug 2021 16:13:21 +0200 Subject: [PATCH] Update, clean up VS Code dev container definition (#1863) * Update and clean up - Use current hyperlinks. - Remove redundant explanation and refer to official docs, now dev containers have gained maturity. * Update and clean up - Spell project name more correctly. - Normalize `Dockerfile` path. - Remove deprecated setting, leave it to the defaults. - Add the EditorConfig extension, since the project uses it already and the functionality is quite critical for contribution. --- .devcontainer/README.md | 11 +++-------- .devcontainer/devcontainer.json | 10 ++++------ 2 files changed, 7 insertions(+), 14 deletions(-) diff --git a/.devcontainer/README.md b/.devcontainer/README.md index daa78051..e8ddd273 100644 --- a/.devcontainer/README.md +++ b/.devcontainer/README.md @@ -1,10 +1,5 @@ -# Devcontainer +# Visual Studio Code dev container configuration -This file specifies to vscode how to run the container +This file specifies to Visual Studio Code how to run a [dev container](https://code.visualstudio.com/docs/remote/containers). -For format details, see [documentation](https://aka.ms/vscode-remote/devcontainer.json) or this file's [README](https://github.com/microsoft/vscode-dev-containers/tree/v0.123.0/containers/docker-existing-dockerfile) - -context: Sets the run context to one level up instead of the .devcontainer folder. -dockerFile: Update the 'dockerFile' property if you aren't using the standard 'Dockerfile' filename. -settings: Set _default_ container specific settings.json values on container create. -extensions: Add the IDs of extensions you want installed when the container is created. +For format details, see [documentation](https://code.visualstudio.com/docs/remote/devcontainerjson-reference). diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index f6e6a287..cf74f5a4 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -1,12 +1,10 @@ { - "name": "SUPER-LINTER", + "name": "Super-Linter", "context": "..", - "dockerFile": "..//Dockerfile", - "settings": { - "terminal.integrated.shell.linux": "/bin/bash" - }, + "dockerFile": "../Dockerfile", "extensions": [ "github.vscode-pull-request-github", - "rogalmic.bash-debug" + "rogalmic.bash-debug", + "EditorConfig.EditorConfig" ] }