Merge pull request #142 from microsoft/clantz/node-refactor

Remove "lts" / "latest" definitions in favor of version, add eslint to TS definitions

Author: Chuxel

containers/azure-functions-node-lts/.devcontainer/Dockerfile renamed to containers/azure-functions-node-10/.devcontainer/Dockerfile

@@ -3,7 +3,7 @@
 # Licensed under the MIT License. See https://go.microsoft.com/fwlink/?linkid=2090316 for license information.
 #-------------------------------------------------------------------------------------------------------------
 
-FROM node:lts
+FROM node:10
 
 # Avoid warnings by switching to noninteractive
 ENV DEBIAN_FRONTEND=noninteractive

containers/azure-functions-node-lts/.devcontainer/devcontainer.json renamed to containers/azure-functions-node-10/.devcontainer/devcontainer.json

@@ -1,5 +1,5 @@
 {
-	"name": "Azure Functions & Node.js (latest LTS)",
+	"name": "Azure Functions & Node.js 10",
 	"dockerFile": "Dockerfile",
 	"appPort": 7071,
 

containers/azure-functions-node-lts/.npmignore renamed to containers/azure-functions-node-10/.npmignore

@@ -1,8 +1,8 @@
-# Azure Functions & Node.js (latest LTS)
+# Azure Functions & Node.js 10
 
 ## Summary
 
-*Develop Azure Functions in Node.js. Includes Node.js (latest LTS), eslint, the Azure Functions SDK, and related extensions and dependencies.*
+*Develop Azure Functions in Node.js. Includes Node.js 10, eslint, the Azure Functions SDK, and related extensions and dependencies.*
 
 | Metadata | Value |  
 |----------|-------|
@@ -19,11 +19,11 @@ This definition requires an Azure subscription to use. You can create a [free ac
 2. To use VS Code's copy of this definition:
    1. Start VS Code and open your project folder.
    2. Press <kbd>F1</kbd> select and **Remote-Containers: Add Development Container Configuration Files...** from the command palette.
-   3. Select the Azure Functions & Node.js (latest LTS) definition.
+   3. Select the Azure Functions & Node.js 10 definition.
 
 3. To use latest-and-greatest copy of this definition from the repository:
    1. Clone this repository.
-   2. Copy the contents of `containers/azure-functions-node-lts/.devcontainer` to the root of your project folder.
+   2. Copy the contents of `containers/azure-functions-node-10/.devcontainer` to the root of your project folder.
    3. Start VS Code and open your project folder.
 
 4. After following step 2 or 3, the contents of the `.devcontainer` folder in your project can be adapted to meet your needs.
@@ -37,7 +37,7 @@ This definition includes some test code that will help you verify it is working
 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.
 2. Clone this repository.
 3. Start VS Code, press <kbd>F1</kbd>, and select **Remote-Containers: Open Folder in Container...**
-4. Select the `containers/azure-functions-node-8` folder.
+4. Select the `containers/azure-functions-node-10` folder.
 5. After the folder has opened in the container, press <kbd>F1</kbd> and select **Azure Functions: Create Function...**.
 6. Enter these options:
    1. Yes (when prompted to create a new project)

containers/azure-functions-node-lts/README.md renamed to containers/azure-functions-node-10/README.md

@@ -2,8 +2,8 @@
 # Copyright (c) Microsoft Corporation. All rights reserved.
 # Licensed under the MIT License. See https://go.microsoft.com/fwlink/?linkid=2090316 for license information.
 #-------------------------------------------------------------------------------------------------------------
-
-FROM mcr.microsoft.com/dotnet/core/sdk:2.1
+ARG DOTNETCORE_VESRION=2.1
+FROM mcr.microsoft.com/dotnet/core/sdk:${DOTNETCORE_VESRION}
 
 # This Dockerfile adds a non-root 'vscode' user with sudo access. However, for Linux,
 # this user's GID/UID must match your local user UID/GID to avoid permission issues
@@ -15,7 +15,8 @@ ARG USER_GID=$USER_UID
 
 # [Optional] Version of Node.js to install.
 ARG INSTALL_NODE="true"
-ARG NODE_MAJOR_VERSION="10"
+ARG NODE_VERSION="lts/*"
+ENV NVM_DIR=/home/vscode/.nvm
 
 # [Optional] Install the Azure CLI
 ARG INSTALL_AZURE_CLI="false"
@@ -28,31 +29,46 @@ RUN apt-get update \
     && apt-get -y install --no-install-recommends apt-utils dialog 2>&1 \
     #
     # Verify git, process tools, lsb-release (common in install instructions for CLIs) installed
-    && apt-get -y install git iproute2 procps lsb-release \
+    && apt-get -y install git iproute2 procps apt-transport-https gnupg2 curl lsb-release \
+    #
+    # Create a non-root user to use if preferred - see https://aka.ms/vscode-remote/containers/non-root-user.
+    && groupadd --gid $USER_GID $USERNAME \
+    && useradd -s /bin/bash --uid $USER_UID --gid $USER_GID -m $USERNAME \
+    # [Optional] Add sudo support for the non-root user
+    && apt-get install -y sudo \
+    && echo $USERNAME ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME\
+    && chmod 0440 /etc/sudoers.d/$USERNAME \
     #
     # [Optional] Install Node.js for ASP.NET Core Web Applicationss
     && if [ "$INSTALL_NODE" = "true" ]; then \
-        curl -sL https://deb.nodesource.com/setup_$NODE_MAJOR_VERSION.x | bash - \
-        && apt-get install -y nodejs; \
+        #
+        # Install nvm and Node
+        mkdir ${NVM_DIR} \
+        && curl -so- https://raw.githubusercontent.com/creationix/nvm/v0.34.0/install.sh | bash 2>&1 \
+        && chown -R vscode:vscode ${NVM_DIR} \
+        && /bin/bash -c "source $NVM_DIR/nvm.sh \
+            && nvm install ${NODE_VERSION} \
+            && nvm alias default ${NODE_VERSION}" 2>&1 \
+        && INIT_STRING='[ -s "$NVM_DIR/nvm.sh" ] && \\. "$NVM_DIR/nvm.sh"  && [ -s "$NVM_DIR/bash_completion" ] && \\. "$NVM_DIR/bash_completion"' \
+        && echo $INIT_STRING >> /home/vscode/.bashrc \
+        && echo $INIT_STRING >> /home/vscode/.zshrc \
+        && echo $INIT_STRING >> /root/.zshrc \
+        #
+        # Install yarn
+        && curl -sS https://dl.yarnpkg.com/$(lsb_release -is | tr '[:upper:]' '[:lower:]')/pubkey.gpg | apt-key add - 2>/dev/null \
+        && echo "deb https://dl.yarnpkg.com/$(lsb_release -is | tr '[:upper:]' '[:lower:]')/ stable main" | tee /etc/apt/sources.list.d/yarn.list \
+        && apt-get update \
+        && apt-get -y install --no-install-recommends yarn; \
     fi \
     #
     # [Optional] Install the Azure CLI
     && if [ "$INSTALL_AZURE_CLI" = "true" ]; then \
-        apt-get install -y apt-transport-https curl gnupg2 lsb-release \
-        && echo "deb [arch=amd64] https://packages.microsoft.com/repos/azure-cli/ $(lsb_release -cs) main" > /etc/apt/sources.list.d/azure-cli.list \
+        echo "deb [arch=amd64] https://packages.microsoft.com/repos/azure-cli/ $(lsb_release -cs) main" > /etc/apt/sources.list.d/azure-cli.list \
         && curl -sL https://packages.microsoft.com/keys/microsoft.asc | apt-key add - 2>/dev/null \
         && apt-get update \
         && apt-get install -y azure-cli; \
     fi \
     #
-    # Create a non-root user to use if preferred - see https://aka.ms/vscode-remote/containers/non-root-user.
-    && groupadd --gid $USER_GID $USERNAME \
-    && useradd -s /bin/bash --uid $USER_UID --gid $USER_GID -m $USERNAME \
-    # [Optional] Add sudo support for the non-root user
-    && apt-get install -y sudo \
-    && echo $USERNAME ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME\
-    && chmod 0440 /etc/sudoers.d/$USERNAME \
-    #
     # Clean up
     && apt-get autoremove -y \
     && apt-get clean -y \

containers/dotnetcore-2.1/.devcontainer/Dockerfile

@@ -8,16 +8,33 @@
 		"terminal.integrated.shell.linux": "/bin/bash"
 	},
 
-	// Uncomment the next line if you want to publish any ports.
-	// "appPort": [],
-
 	// Uncomment the next line to run commands after the container is created.
 	// "postCreateCommand": "dotnet restore"
 
-	// Uncomment the next line to use a non-root user. On Linux, this will prevent
-	// new files getting created as root, but you may need to update the USER_UID
-	// and USER_GID in .devcontainer/Dockerfile to match your user if not 1000.
-	// "runArgs": [ "-u", "vscode" ],
+	// Uncomment the next line if you want to publish any ports.
+	// "appPort": [5000, 5001],
+
+	"runArgs": [
+		// Uncomment the next line to use a non-root user. On Linux, this will prevent
+		// new files getting created as root, but you may need to update the USER_UID
+		// and USER_GID in .devcontainer/Dockerfile to match your user if not 1000.
+		// "-u", "vscode",
+
+		// [Optional] Enable HTTPS in ASP.NET by mount a local dev cert exported the dotnet CLI locally:
+		//   Windows PowerShell:
+		//     dotnet dev-certs https --trust; dotnet dev-certs https -ep "$env:USERPROFILE/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere" 
+		//   macOS/Linux terminal:
+		//     dotnet dev-certs https --trust && dotnet dev-certs https -ep "${HOME}/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere"
+		//
+		// After running the command above, uncomment the lines below and open / rebuild the container.
+		// "-v", "${env:HOME}${env:USERPROFILE}/.aspnet/https:/home/vscode/.aspnet/https"
+		// "-e", "ASPNETCORE_Kestrel__Endpoints__Https__Url=https://*:5001",
+		// "-e", "ASPNETCORE_Kestrel__Certificates__Default__Password=SecurePwdGoesHere",
+		// "-e", "ASPNETCORE_Kestrel__Certificates__Default__Path=/home/vscode/.aspnet/https/aspnetapp.pfx",
+
+		// [Optional] Override the default HTTP endpoints - need to listen to '*' for appPort to work
+		"-e", "ASPNETCORE_Kestrel__Endpoints__Http__Url=http://*:5000"
+	],
 
 	// Add the IDs of extensions you want installed when the container is created in the array below.
 	"extensions": [

containers/dotnetcore-2.1/.devcontainer/devcontainer.json

@@ -12,28 +12,79 @@
 
 ## Using this definition with an existing folder
 
-A few notes on this definition:
+While the definition itself works unmodified, there are some tips that can help you deal with some of the defaults .NET Core uses.
 
-1. Only the integrated terminal is supported by the Remote - Containers extension. You may need to modify `launch.json` configurations to include the following value if an external console is used.
+### Using appPort with ASP.NET Core
 
-    ```json
-    "console": "integratedTerminal"
-    ```
+By default, ASP.NET Core only listens to localhost. The challenge is that ASP.NET Core thinks that localhost is inside the container. If you use the `appPort` property in `.devcontainer/devcontainer.json`, the port is [published](https://docs.docker.com/config/containers/container-networking/#published-ports) rather than forwarded. So you can override the defaults so that ASP.NET will listen to traffic from your local machine as well.
 
-2. Given how frequently ASP.NET applications use Node.js for front end code, this container also includes Node.js. You can change the version of Node.js installed or disable its installation by updating these lines in `.devcontainer/Dockerfile`.
+```json
+"appPort": [5000, 5001],
+"runArgs": [
+    "-e", "ASPNETCORE_Kestrel__Endpoints__Http__Url=http://*:5000",
+    "-e", "ASPNETCORE_Kestrel__Endpoints__Https__Url=https://*:5001"
+]
+```
 
-    ```Dockerfile
-    ARG INSTALL_NODE="true"
-    ARG NODE_MAJOR_VERSION="10"
-    ```
+Rebuild the container using the **Remote-Containers: Rebuild Container** command from the Command Palette (<kbd>F1</kbd>) if you've already opened your folder in a container so the settings take effect.
 
-3. If you would like to install the Azure CLI update this line in `.devcontainer/Dockerfile`:
+### Enabling HTTPS in ASP.NET Core
 
-    ```Dockerfile
-    ARG INSTALL_AZURE_CLI="true"
-    ```
+To enable HTTPS in ASP.NET, you can mount an exported copy of your local dev certificate. First, export it using the following command:
 
-Beyond that, just follow these steps to use the definition:
+**Windows PowerShell**
+
+```powershell
+dotnet dev-certs https --trust; dotnet dev-certs https -ep "$env:USERPROFILE/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere"
+```
+
+**macOS/Linux terminal**
+
+```powershell
+dotnet dev-certs https --trust && dotnet dev-certs https -ep "${HOME}/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere"
+```
+
+Next, add the following in the `runArgs` array in `.devcontainer/devcontainer.json` (assuming port 5000 and 5001 are the correct ports):
+
+```json
+"appPort": [5000, 5001],
+"runArgs": [
+    "-e", "ASPNETCORE_Kestrel__Endpoints__Http__Url=http://*:5000",
+    "-e", "ASPNETCORE_Kestrel__Endpoints__Https__Url=https://*:5001",
+    "-v", "${env:HOME}${env:USERPROFILE}/.aspnet/https:/home/vscode/.aspnet/https",
+    "-e", "ASPNETCORE_Kestrel__Certificates__Default__Password=SecurePwdGoesHere",
+    "-e", "ASPNETCORE_Kestrel__Certificates__Default__Path=/home/vscode/.aspnet/https/aspnetapp.pfx"
+]
+```
+
+Rebuild the container using the **Remote-Containers: Rebuild Container** command from the Command Palette (<kbd>F1</kbd>) if you've already opened your folder in a container so the settings take effect.
+
+### Debug Configuration
+
+Only the integrated terminal is supported by the Remote - Containers extension. You may need to modify `launch.json` configurations to include the following value if an external console is used.
+
+```json
+"console": "integratedTerminal"
+```
+
+### Installing Node.js or the Azure CLI
+
+Given how frequently ASP.NET applications use Node.js for front end code, this container also includes Node.js. You can change the version of Node.js installed or disable its installation by updating these lines in `.devcontainer/Dockerfile`.
+
+```Dockerfile
+ARG INSTALL_NODE="true"
+ARG NODE_VERSION="10"
+```
+
+If you would like to install the Azure CLI update this line in `.devcontainer/Dockerfile`:
+
+```Dockerfile
+ARG INSTALL_AZURE_CLI="true"
+```
+
+Rebuild the container using the **Remote-Containers: Rebuild Container** command from the Command Palette (<kbd>F1</kbd>) if you've already opened your folder in a container so the settings take effect.
+
+### Adding the definition to your folder
 
 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.
 

containers/dotnetcore-2.1/README.md

@@ -3,9 +3,10 @@
 # Licensed under the MIT License. See https://go.microsoft.com/fwlink/?linkid=2090316 for license information.
 #-------------------------------------------------------------------------------------------------------------
 
-FROM mcr.microsoft.com/dotnet/core/sdk:2.2
+ARG DOTNETCORE_VESRION=2.2
+FROM mcr.microsoft.com/dotnet/core/sdk:${DOTNETCORE_VESRION}
 
-## This Dockerfile adds a non-root 'vscode' user with sudo access. However, for Linux,
+# This Dockerfile adds a non-root 'vscode' user with sudo access. However, for Linux,
 # this user's GID/UID must match your local user UID/GID to avoid permission issues
 # with bind mounts. Update USER_UID / USER_GID if yours is not 1000. See
 # https://aka.ms/vscode-remote/containers/non-root-user for details.
@@ -15,7 +16,8 @@ ARG USER_GID=$USER_UID
 
 # [Optional] Version of Node.js to install.
 ARG INSTALL_NODE="true"
-ARG NODE_MAJOR_VERSION="10"
+ARG NODE_VERSION="lts/*"
+ENV NVM_DIR=/home/vscode/.nvm
 
 # [Optional] Install the Azure CLI
 ARG INSTALL_AZURE_CLI="false"
@@ -28,31 +30,46 @@ RUN apt-get update \
     && apt-get -y install --no-install-recommends apt-utils dialog 2>&1 \
     #
     # Verify git, process tools, lsb-release (common in install instructions for CLIs) installed
-    && apt-get -y install git iproute2 procps lsb-release \
+    && apt-get -y install git iproute2 procps apt-transport-https gnupg2 curl lsb-release \
+    #
+    # Create a non-root user to use if preferred - see https://aka.ms/vscode-remote/containers/non-root-user.
+    && groupadd --gid $USER_GID $USERNAME \
+    && useradd -s /bin/bash --uid $USER_UID --gid $USER_GID -m $USERNAME \
+    # [Optional] Add sudo support for the non-root user
+    && apt-get install -y sudo \
+    && echo $USERNAME ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME\
+    && chmod 0440 /etc/sudoers.d/$USERNAME \
     #
     # [Optional] Install Node.js for ASP.NET Core Web Applicationss
     && if [ "$INSTALL_NODE" = "true" ]; then \
-        curl -sL https://deb.nodesource.com/setup_$NODE_MAJOR_VERSION.x | bash - \
-        && apt-get install -y nodejs; \
+        #
+        # Install nvm and Node
+        mkdir ${NVM_DIR} \
+        && curl -so- https://raw.githubusercontent.com/creationix/nvm/v0.34.0/install.sh | bash 2>&1 \
+        && chown -R vscode:vscode ${NVM_DIR} \
+        && /bin/bash -c "source $NVM_DIR/nvm.sh \
+            && nvm install ${NODE_VERSION} \
+            && nvm alias default ${NODE_VERSION}" 2>&1 \
+        && INIT_STRING='[ -s "$NVM_DIR/nvm.sh" ] && \\. "$NVM_DIR/nvm.sh"  && [ -s "$NVM_DIR/bash_completion" ] && \\. "$NVM_DIR/bash_completion"' \
+        && echo $INIT_STRING >> /home/vscode/.bashrc \
+        && echo $INIT_STRING >> /home/vscode/.zshrc \
+        && echo $INIT_STRING >> /root/.zshrc \
+        #
+        # Install yarn
+        && curl -sS https://dl.yarnpkg.com/$(lsb_release -is | tr '[:upper:]' '[:lower:]')/pubkey.gpg | apt-key add - 2>/dev/null \
+        && echo "deb https://dl.yarnpkg.com/$(lsb_release -is | tr '[:upper:]' '[:lower:]')/ stable main" | tee /etc/apt/sources.list.d/yarn.list \
+        && apt-get update \
+        && apt-get -y install --no-install-recommends yarn; \
     fi \
     #
     # [Optional] Install the Azure CLI
     && if [ "$INSTALL_AZURE_CLI" = "true" ]; then \
-        apt-get install -y apt-transport-https curl gnupg2 lsb-release \
-        && echo "deb [arch=amd64] https://packages.microsoft.com/repos/azure-cli/ $(lsb_release -cs) main" > /etc/apt/sources.list.d/azure-cli.list \
+        echo "deb [arch=amd64] https://packages.microsoft.com/repos/azure-cli/ $(lsb_release -cs) main" > /etc/apt/sources.list.d/azure-cli.list \
         && curl -sL https://packages.microsoft.com/keys/microsoft.asc | apt-key add - 2>/dev/null \
         && apt-get update \
         && apt-get install -y azure-cli; \
     fi \
     #
-    # Create a non-root user to use if preferred - see https://aka.ms/vscode-remote/containers/non-root-user.
-    && groupadd --gid $USER_GID $USERNAME \
-    && useradd -s /bin/bash --uid $USER_UID --gid $USER_GID -m $USERNAME \
-    # [Optional] Add sudo support for the non-root user
-    && apt-get install -y sudo \
-    && echo $USERNAME ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME\
-    && chmod 0440 /etc/sudoers.d/$USERNAME \
-    #
     # Clean up
     && apt-get autoremove -y \
     && apt-get clean -y \

containers/dotnetcore-2.2/.devcontainer/Dockerfile

@@ -8,16 +8,33 @@
 		"terminal.integrated.shell.linux": "/bin/bash"
 	},
 
-	// Uncomment the next line if you want to publish any ports.
-	// "appPort": [],
-
 	// Uncomment the next line to run commands after the container is created.
 	// "postCreateCommand": "dotnet restore"
 
-	// Uncomment the next line to use a non-root user. On Linux, this will prevent
-	// new files getting created as root, but you may need to update the USER_UID
-	// and USER_GID in .devcontainer/Dockerfile to match your user if not 1000.
-	// "runArgs": [ "-u", "vscode" ],
+	// Uncomment the next line if you want to publish any ports.
+	// "appPort": [5000, 5001],
+
+	"runArgs": [
+		// Uncomment the next line to use a non-root user. On Linux, this will prevent
+		// new files getting created as root, but you may need to update the USER_UID
+		// and USER_GID in .devcontainer/Dockerfile to match your user if not 1000.
+		// "-u", "vscode",
+
+		// [Optional] Enable HTTPS in ASP.NET by mount a local dev cert exported the dotnet CLI locally:
+		//   Windows PowerShell:
+		//     dotnet dev-certs https --trust; dotnet dev-certs https -ep "$env:USERPROFILE/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere" 
+		//   macOS/Linux terminal:
+		//     dotnet dev-certs https --trust && dotnet dev-certs https -ep "${HOME}/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere"
+		//
+		// After running the command above, uncomment the lines below and open / rebuild the container.
+		// "-v", "${env:HOME}${env:USERPROFILE}/.aspnet/https:/home/vscode/.aspnet/https"
+		// "-e", "ASPNETCORE_Kestrel__Endpoints__Https__Url=https://*:5001",
+		// "-e", "ASPNETCORE_Kestrel__Certificates__Default__Password=SecurePwdGoesHere",
+		// "-e", "ASPNETCORE_Kestrel__Certificates__Default__Path=/home/vscode/.aspnet/https/aspnetapp.pfx",
+
+		// [Optional] Override the default HTTP endpoints - need to listen to '*' for appPort to work
+		"-e", "ASPNETCORE_Kestrel__Endpoints__Http__Url=http://*:5000"
+	],
 
 	// Add the IDs of extensions you want installed when the container is created in the array below.
 	"extensions": [