Skip to content

Commit

Permalink
do not lint by default, update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
chrisdias committed Dec 4, 2016
1 parent 27bf6ec commit 1761752
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 6 deletions.
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,25 @@ The Docker extension it easy to build and deploy containerized applications from
## Generating Dockerfile, docker-compose.yml, and docker-compose.debug.yml
![dockerfile](images/generateFiles.gif)

Similar functionality is available for Docker compose files (v1 and v2 formats):
IntelliSense (completions) for Dockerfile and docker-compose.yml files, including listing images from Dockerhub.com.

![composefile](images/dockercompose.gif)
![intelliSense](images/intelliSense.gif)

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

![intelliSense](images/commands.gif)

## 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](https://github.com/projectatomic/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](https://github.com/projectatomic/dockerfile_lint#extending-and-customizing-rule-files) on how to create rules files as well as [sample rules files](https://github.com/projectatomic/dockerfile_lint/tree/master/sample_rules) in the [dockerfile_lint](https://github.com/projectatomic/dockerfile_lint) project.

![linting](images/linting.gif)

## Installation
Installation is easy! 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.
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`).

![installation](images/installing.gif)

## 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](https://docs.docker.com/engine/installation/linux/ubuntulinux/#/create-a-docker-group)

Expand Down
Binary file added images/commands.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/intelliSense.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/linting.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@
},
"docker.enableLinting": {
"type": "boolean",
"default": true,
"default": false,
"description": "Turn linting of Dockerfiles on or off."
},
"docker.linterRuleFile": {
Expand Down

0 comments on commit 1761752

Please sign in to comment.