Update template, add features and image metadata info (#28)
This commit is contained in:
		@@ -1,8 +0,0 @@
 | 
				
			|||||||
# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.195.0/containers/rust/.devcontainer/base.Dockerfile
 | 
					 | 
				
			||||||
# [Choice] Debian OS version (use bullseye on local arm64/Apple Silicon): buster, bullseye
 | 
					 | 
				
			||||||
ARG VARIANT="bullseye"
 | 
					 | 
				
			||||||
FROM mcr.microsoft.com/devcontainers/rust:1-${VARIANT}
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
# [Optional] Uncomment this section to install additional packages.
 | 
					 | 
				
			||||||
# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
 | 
					 | 
				
			||||||
#     && apt-get -y install --no-install-recommends <your-package-list-here>
 | 
					 | 
				
			||||||
@@ -1,41 +1,23 @@
 | 
				
			|||||||
// For format details, see https://aka.ms/vscode-remote/devcontainer.json or this file's README at:
 | 
					// For format details, see https://aka.ms/devcontainer.json. For config options, see the
 | 
				
			||||||
// https://github.com/microsoft/vscode-dev-containers/tree/v0.195.0/containers/rust
 | 
					// README at: https://github.com/devcontainers/templates/tree/main/src/rust
 | 
				
			||||||
{
 | 
					{
 | 
				
			||||||
	"name": "Rust Sample",
 | 
						"name": "Rust",
 | 
				
			||||||
	"build": {
 | 
						// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
 | 
				
			||||||
		"dockerfile": "Dockerfile",
 | 
						"image": "mcr.microsoft.com/devcontainers/rust:0-1-bullseye",
 | 
				
			||||||
		"args": {
 | 
					
 | 
				
			||||||
			// Use the VARIANT arg to pick a Debian OS version: buster, bullseye
 | 
						// Features to add to the dev container. More info: https://containers.dev/features.
 | 
				
			||||||
			// Use bullseye when on local on arm64/Apple Silicon.
 | 
						// "features": {},
 | 
				
			||||||
			"VARIANT": "bullseye"
 | 
					 | 
				
			||||||
		}
 | 
					 | 
				
			||||||
	},
 | 
					 | 
				
			||||||
	"runArgs": [ "--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined" ],
 | 
					 | 
				
			||||||
 | 
					
 | 
				
			||||||
	// Configure tool-specific properties.
 | 
						// Configure tool-specific properties.
 | 
				
			||||||
	"customizations": {
 | 
						"customizations": {
 | 
				
			||||||
		// Configure properties specific to VS Code.
 | 
							// Configure properties specific to VS Code.
 | 
				
			||||||
		"vscode": {
 | 
							"vscode": {
 | 
				
			||||||
			// Set *default* container specific settings.json values on container create.
 | 
								"settings": {},
 | 
				
			||||||
			"settings": { 
 | 
					 | 
				
			||||||
				"lldb.executable": "/usr/bin/lldb",
 | 
					 | 
				
			||||||
				// VS Code don't watch files under ./target
 | 
					 | 
				
			||||||
				"files.watcherExclude": {
 | 
					 | 
				
			||||||
					"**/target/**": true
 | 
					 | 
				
			||||||
				},
 | 
					 | 
				
			||||||
				"rust-analyzer.checkOnSave.command": "clippy"
 | 
					 | 
				
			||||||
			},
 | 
					 | 
				
			||||||
			
 | 
					 | 
				
			||||||
			// Add the IDs of extensions you want installed when the container is created.
 | 
					 | 
				
			||||||
			"extensions": [
 | 
								"extensions": [
 | 
				
			||||||
				"vadimcn.vscode-lldb",
 | 
									"streetsidesoftware.code-spell-checker"
 | 
				
			||||||
				"mutantdino.resourcemonitor",
 | 
					 | 
				
			||||||
				"rust-lang.rust-analyzer",
 | 
					 | 
				
			||||||
				"tamasfe.even-better-toml",
 | 
					 | 
				
			||||||
				"serayuzgur.crates"
 | 
					 | 
				
			||||||
			]
 | 
								]
 | 
				
			||||||
		}
 | 
							}
 | 
				
			||||||
	},
 | 
						}
 | 
				
			||||||
 | 
					
 | 
				
			||||||
	// Use 'forwardPorts' to make a list of ports inside the container available locally.
 | 
						// Use 'forwardPorts' to make a list of ports inside the container available locally.
 | 
				
			||||||
	// "forwardPorts": [],
 | 
						// "forwardPorts": [],
 | 
				
			||||||
@@ -43,6 +25,6 @@
 | 
				
			|||||||
	// Use 'postCreateCommand' to run commands after the container is created.
 | 
						// Use 'postCreateCommand' to run commands after the container is created.
 | 
				
			||||||
	// "postCreateCommand": "rustc --version",
 | 
						// "postCreateCommand": "rustc --version",
 | 
				
			||||||
 | 
					
 | 
				
			||||||
	// Comment out to run as root instead.
 | 
						// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
 | 
				
			||||||
	"remoteUser": "vscode"
 | 
						// "remoteUser": "root"
 | 
				
			||||||
}
 | 
					}
 | 
				
			||||||
 
 | 
				
			|||||||
							
								
								
									
										17
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										17
									
								
								README.md
									
									
									
									
									
								
							@@ -2,7 +2,7 @@
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/vscode-remote-try-rust)
 | 
					[](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/vscode-remote-try-rust)
 | 
				
			||||||
 | 
					
 | 
				
			||||||
A **development container** is a running [Docker](https://www.docker.com) container with a well-defined tool/runtime stack and its prerequisites. You can try out development containers with **[GitHub Codespaces](https://github.com/features/codespaces)** or **[Visual Studio Code Dev Containers](https://aka.ms/vscode-remote/containers)**.
 | 
					A **development container** is a running container with a well-defined tool/runtime stack and its prerequisites. You can try out development containers with **[GitHub Codespaces](https://github.com/features/codespaces)** or **[Visual Studio Code Dev Containers](https://aka.ms/vscode-remote/containers)**.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
This is a sample project that lets you try out either option in a few easy steps. We have a variety of other [vscode-remote-try-*](https://github.com/search?q=org%3Amicrosoft+vscode-remote-try-&type=Repositories) sample projects, too.
 | 
					This is a sample project that lets you try out either option in a few easy steps. We have a variety of other [vscode-remote-try-*](https://github.com/search?q=org%3Amicrosoft+vscode-remote-try-&type=Repositories) sample projects, too.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
@@ -41,21 +41,30 @@ Follow these steps to open this sample in a container using the VS Code Dev Cont
 | 
				
			|||||||
 | 
					
 | 
				
			||||||
Once you have this sample opened, you'll be able to work with it like you would locally.
 | 
					Once you have this sample opened, you'll be able to work with it like you would locally.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
> **Note:** This container runs as a non-root user with sudo access by default. Comment out `"remoteUser": "vscode"` in `.devcontainer/devcontainer.json` if you'd prefer to run as root.
 | 
					 | 
				
			||||||
 | 
					 | 
				
			||||||
Some things to try:
 | 
					Some things to try:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
1. **Edit:**
 | 
					1. **Edit:**
 | 
				
			||||||
   - Open `main.rs`
 | 
					   - Open `main.rs`
 | 
				
			||||||
   - Try adding some code and check out the language features.
 | 
					   - Try adding some code and check out the language features.
 | 
				
			||||||
   - Notice that several extensions are already installed in the container, such as Rust support for VS Code, since the `.devcontainer/devcontainer.json` lists a set of extensions, including `"rust-lang.rust"`, to install automatically when the container is created.
 | 
					   - Make a spelling mistake and notice it is detected. The [Code Spell Checker](https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker) extension was automatically installed because it is referenced in `.devcontainer/devcontainer.json`.
 | 
				
			||||||
 | 
					   - Also notice that utilities like `rls` and the [Rust Analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer) extension are installed. Tools are installed in the `mcr.microsoft.com/devcontainers/rust` image and Dev Container settings and metadata are automatically picked up from [image labels](https://containers.dev/implementors/reference/#labels).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
1. **Terminal:** Press <kbd>ctrl</kbd>+<kbd>shift</kbd>+<kbd>\`</kbd> and type `uname` and other Linux commands from the terminal window.
 | 
					1. **Terminal:** Press <kbd>ctrl</kbd>+<kbd>shift</kbd>+<kbd>\`</kbd> and type `uname` and other Linux commands from the terminal window.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
1. **Build, Run, and Debug:**
 | 
					1. **Build, Run, and Debug:**
 | 
				
			||||||
   - Open `main.rs`
 | 
					   - Open `main.rs`
 | 
				
			||||||
   - Add a breakpoint (e.g. on line 8).
 | 
					   - Add a breakpoint (e.g. on line 8).
 | 
				
			||||||
   - Press <kbd>F5</kbd> to launch the app in the container.
 | 
					   - Press <kbd>F5</kbd> to launch the app in the container.
 | 
				
			||||||
   - Once the breakpoint is hit, try hovering over variables, examining locals, and more.
 | 
					   - Once the breakpoint is hit, try hovering over variables, examining locals, and more.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					1. **Install the GitHub CLI using a Dev Container Feature:**
 | 
				
			||||||
 | 
					   - Press <kbd>F1</kbd> and select the **Dev Containers: Configure Container Features...** or **Codespaces: Configure Container Features...** command.
 | 
				
			||||||
 | 
					   - Type "github" in the text box at the top.
 | 
				
			||||||
 | 
					   - Check the check box next to "GitHub CLI" (published by devcontainers) 
 | 
				
			||||||
 | 
					   - Click OK
 | 
				
			||||||
 | 
					   - Press <kbd>F1</kbd> and select the **Dev Containers: Rebuild Container** or **Codespaces: Rebuild Container** command so the modifications are picked up.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					 
 | 
				
			||||||
## Contributing
 | 
					## Contributing
 | 
				
			||||||
 | 
					
 | 
				
			||||||
This project welcomes contributions and suggestions. Most contributions require you to agree to a
 | 
					This project welcomes contributions and suggestions. Most contributions require you to agree to a
 | 
				
			||||||
 
 | 
				
			|||||||
		Reference in New Issue
	
	Block a user