Skip to content

Commit a9c8d98

Browse files
committed
Update README
1 parent e06fd4d commit a9c8d98

File tree

1 file changed

+10
-60
lines changed

1 file changed

+10
-60
lines changed

src/javascript-node/README.md

Lines changed: 10 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -6,84 +6,34 @@
66

77
| Metadata | Value |
88
|----------|-------|
9-
| *Contributors* | The VS Code Team |
109
| *Categories* | Core, Languages |
1110
| *Image type* | Dockerfile |
1211
| *Published image* | mcr.microsoft.com/devcontainers/javascript-node |
1312
| *Available image variants* | 18 / 18-bullseye, 16 / 16-bullseye, 14 / 14-bullseye, 18-buster, 16-buster, 14-buster ([full list](https://mcr.microsoft.com/v2/devcontainers/javascript-node/tags/list)) |
1413
| *Published image architecture(s)* | x86-64, arm64/aarch64 for `bullseye` variants |
15-
| *Works in Codespaces* | Yes |
1614
| *Container host OS support* | Linux, macOS, Windows |
1715
| *Container OS* | Debian |
1816
| *Languages, platforms* | Node.js, JavaScript |
1917

20-
See **[history](history)** for information on the contents of published images.
21-
2218
## Using this image
2319

24-
While the definition itself works unmodified, you can select the version of Node.js the container uses by updating the `VARIANT` arg in the included `devcontainer.json` (and rebuilding if you've already created the container).
25-
26-
```jsonc
27-
// Or you can use 16-bullseye or 16-buster if you want to pin to an OS version
28-
"args": { "VARIANT": "16" }
29-
```
20+
You can directly reference pre-built versions of `Dockerfile` by using the `image` property in `.devcontainer/devcontainer.json` or updating the `FROM` statement in your own `Dockerfile` to one of the following. An example `Dockerfile` is included in this repository.
3021

31-
You can also directly reference pre-built versions of `.devcontainer/base.Dockerfile` by using the `image` property in `.devcontainer/devcontainer.json` or updating the `FROM` statement in your own `Dockerfile` with one of the following:
32-
33-
- `mcr.microsoft.com/vscode/devcontainers/javascript-node` (latest)
34-
- `mcr.microsoft.com/vscode/devcontainers/javascript-node:18` (or `18-bullseye`, `18-buster` to pin to an OS version)
35-
- `mcr.microsoft.com/vscode/devcontainers/javascript-node:16` (or `16-bullseye`, `16-buster` to pin to an OS version)
36-
- `mcr.microsoft.com/vscode/devcontainers/javascript-node:14` (or `14-bullseye`, `14-buster` to pin to an OS version)
22+
- `mcr.microsoft.com/devcontainers/javascript-node` (latest)
23+
- `mcr.microsoft.com/devcontainers/javascript-node:18` (or `18-bullseye`, `18-buster` to pin to an OS version)
24+
- `mcr.microsoft.com/devcontainers/javascript-node:16` (or `16-bullseye`, `16-buster` to pin to an OS version)
25+
- `mcr.microsoft.com/devcontainers/javascript-node:14` (or `14-bullseye`, `14-buster` to pin to an OS version)
3726

3827
You can decide how often you want updates by referencing a [semantic version](https://semver.org/) of each image. For example:
3928

40-
- `mcr.microsoft.com/vscode/devcontainers/typescript-node:0-16` (or `0-16-bullseye`, `0-16-buster`)
41-
- `mcr.microsoft.com/vscode/devcontainers/typescript-node:0.204-16` (or `0.204-16-bullseye`, `0.204-16-buster`)
42-
- `mcr.microsoft.com/vscode/devcontainers/typescript-node:0.204.0-16` (or `0.204.0-16-bullseye`, `0.204.0-16-buster`)
43-
44-
However, we only do security patching on the latest [non-breaking, in support](https://github.com/microsoft/vscode-dev-containers/issues/532) versions of images (e.g. `0-16`). You may want to run `apt-get update && apt-get upgrade` in your Dockerfile if you lock to a more specific version to at least pick up OS security updates.
45-
46-
See [history](history) for information on the contents of each version and [here for a complete list of available tags](https://mcr.microsoft.com/v2/vscode/devcontainers/typescript-node/tags/list).
47-
48-
Alternatively, you can use the contents of `base.Dockerfile` to fully customize your container's contents or to build it for a container host architecture not supported by the image.
49-
50-
Beyond Node.js and `git`, this image / `Dockerfile` includes `eslint`, `zsh`, [Oh My Zsh!](https://ohmyz.sh/), a non-root `vscode` user with `sudo` access, and a set of common dependencies for development. [Node Version Manager](https://github.com/nvm-sh/nvm) (`nvm`) is also included in case you need to use a different version of Node.js than the one included in the image.
51-
52-
### Adding the definition to a project or codespace
53-
54-
1. If this is your first time using a development container, please see getting started information on [setting up](https://aka.ms/vscode-remote/containers/getting-started) Remote-Containers or [creating a codespace](https://aka.ms/ghcs-open-codespace) using GitHub Codespaces.
55-
56-
2. To use the pre-built image:
57-
1. Start VS Code and open your project folder or connect to a codespace.
58-
2. Press <kbd>F1</kbd> select and **Add Development Container Configuration Files...** command for **Remote-Containers** or **Codespaces**.
59-
3. Select this definition. You may also need to select **Show All Definitions...** for it to appear.
60-
61-
3. To build a custom version of the image instead:
62-
1. Clone this repository locally.
63-
2. Start VS Code and open your project folder or connect to a codespace.
64-
3. Use your local operating system's file explorer to drag-and-drop the locally cloned copy of the `.devcontainer` folder for this definition into the VS Code file explorer for your opened project or codespace.
65-
4. Update `.devcontainer/devcontainer.json` to reference `"dockerfile": "base.Dockerfile"`.
66-
67-
4. After following step 2 or 3, the contents of the `.devcontainer` folder in your project can be adapted to meet your needs.
68-
69-
5. Finally, press <kbd>F1</kbd> and run **Remote-Containers: Reopen Folder in Container** or **Codespaces: Rebuild Container** to start using the definition.
70-
71-
## Testing the definition
72-
73-
This definition includes some test code that will help you verify it is working as expected on your system. Follow these steps:
29+
- `mcr.microsoft.com/devcontainers/typescript-node:0-16` (or `0-16-bullseye`, `0-16-buster`)
30+
- `mcr.microsoft.com/devcontainers/typescript-node:0.204-16` (or `0.204-16-bullseye`, `0.204-16-buster`)
31+
- `mcr.microsoft.com/devcontainers/typescript-node:0.204.0-16` (or `0.204.0-16-bullseye`, `0.204.0-16-buster`)
7432

75-
1. If this is your first time using a development container, please follow the [getting started steps](https://aka.ms/vscode-remote/containers/getting-started) to set up your machine.
76-
2. Clone this repository.
77-
3. Start VS Code, press <kbd>F1</kbd>, and select **Remote-Containers: Open Folder in Container...**
78-
4. Select the `containers/javascript-node` folder.
79-
5. After the folder has opened in the container, press <kbd>F5</kbd> to start the project. This will automatically run `npm install` before starting it.
80-
6. Once the project is running, press <kbd>F1</kbd> and select **Remote-Containers: Forward Port from Container...**
81-
7. Select port 3000 and click the "Open Browser" button in the notification that appears.
82-
8. You should see "Hello remote world!" after the page loads.
83-
9. From here, you can add breakpoints or edit the contents of the `test-project` folder to do further testing.
33+
However, we only do security patching on the latest [non-breaking, in support](https://github.com/microsoft/vscode-dev-containers/issues/532) versions of images (e.g. `0-1.16`). You may want to run `apt-get update && apt-get upgrade` in your Dockerfile if you lock to a more specific version to at least pick up OS security updates.
8434

8535
## License
8636

8737
Copyright (c) Microsoft Corporation. All rights reserved.
8838

89-
Licensed under the MIT License. See [LICENSE](https://github.com/microsoft/vscode-dev-containers/blob/main/LICENSE).
39+
Licensed under the MIT License. See [LICENSE](https://github.com/devcontainers/images/blob/main/LICENSE)

0 commit comments

Comments
 (0)