Docker extension for VS Code.
TypeScript

README.md

Docker Support for Visual Studio Code

The Docker extension makes it easy to build and deploy containerized applications from Visual Studio Code.

  • Automatic dockerfile and docker-compose.yml file generation
  • Syntax highlighting and hover tips for docker-compose.yml and dockerfile files
  • Snippets for dockerfile files
  • IntelliSense (completions) on image names from Dockerhub.com
  • Linting (errors and warnings) for dockerfile files
  • Command Palette (F1) integration for the most common Docker commands (e.g. Build, Push)

Generating Dockerfile, docker-compose.yml, and docker-compose.debug.yml

dockerfile

IntelliSense (completions) for Dockerfile and docker-compose.yml files, including listing images from Dockerhub.com.

intelliSense

Docker commands

Many of the most common Docker and docker-compose commands are built right into the Command Palette (F1).

intelliSense

Dockerfile linting

You can enable linting of Dockerfile files through the docker.enableLinting setting (CMD+, on MacOS, or Ctrl+, on Windows and Linux). The extension uses the awesome dockerfile_lint rules based linter to analyze the Dockerfile. You can provide your own customized rules file by setting the docker.linterRuleFile setting. You can find more information on how to create rules files as well as sample rules files in the dockerfile_lint project.

linting

Installation

In VS Code, press F1 and type in ext install vscode-docker. Once the extension is installed you will be prompted to restart Visual Studio Code which will only take (literally) a couple of seconds.

Of course, you will want to have Docker installed on your computer in order to run commands from the Command Palette (F1, type in Docker).

Running commands on Linux

By default, Docker runs as the root user, requiring other users to access it with sudo. This extension does not assume root access, so you will need to create a Unix group called docker and add users to it. Instructions can be found here: Create a Docker group

Contributing

There are a couple of ways you can contribute to this repo:

  • Ideas, feature requests and bugs: We are open to all ideas and we want to get rid of bugs! Use the Issues section to either report a new issue, provide your ideas or contribute to existing threads
  • Documentation: Found a typo or strangely worded sentences? Submit a PR!
  • Code: Contribute bug fixes, features or design changes.

Legal

Before we can accept your pull request you will need to sign a Contribution License Agreement. All you need to do is to submit a pull request, then the PR will get appropriately labelled (e.g. cla-required, cla-norequired, cla-signed, cla-already-signed). If you already signed the agreement we will continue with reviewing the PR, otherwise system will tell you how you can sign the CLA. Once you sign the CLA all future PR's will be labeled as cla-signed.

License

MIT