Merge remote-tracking branch 'origin/main' into pr/codeclown/119480

Author: alexdima

.devcontainer/README.md

@@ -1,97 +1,98 @@
 # Code - OSS Development Container
 
-This repository includes configuration for a development container for working with Code - OSS in an isolated local container or using [GitHub Codespaces](https://github.com/features/codespaces).
+This repository includes configuration for a development container for working with Code - OSS in a local container or using [GitHub Codespaces](https://github.com/features/codespaces).
 
-> **Tip:** The default VNC password is `vscode`. The VNC server runs on port `5901` with a web client at `6080`. For better performance, we recommend using a [VNC Viewer](https://www.realvnc.com/en/connect/download/viewer/). Applications like the macOS Screen Sharing app will not perform as well.
+> **Tip:** The default VNC password is `vscode`. The VNC server runs on port `5901` and a web client is available on port `6080`.
 
 ## Quick start - local
 
 1. Install Docker Desktop or Docker for Linux on your local machine. (See [docs](https://aka.ms/vscode-remote/containers/getting-started) for additional details.)
 
-2. **Important**: Docker needs at least **4 Cores and 6 GB of RAM (8 GB recommended)** to run full build. If you on macOS, or using the old Hyper-V engine for Windows, update these values for Docker Desktop by right-clicking on the Docker status bar item, going to **Preferences/Settings > Resources > Advanced**.
+2. **Important**: Docker needs at least **4 Cores and 6 GB of RAM (8 GB recommended)** to run a full build. If you are on macOS, or are using the old Hyper-V engine for Windows, update these values for Docker Desktop by right-clicking on the Docker status bar item and going to **Preferences/Settings > Resources > Advanced**.
 
     > **Note:** The [Resource Monitor](https://marketplace.visualstudio.com/items?itemName=mutantdino.resourcemonitor) extension is included in the container so you can keep an eye on CPU/Memory in the status bar.
 
 3. Install [Visual Studio Code Stable](https://code.visualstudio.com/) or [Insiders](https://code.visualstudio.com/insiders/) and the [Remote - Containers](https://aka.ms/vscode-remote/download/containers) extension.
 
     ![Image of Remote - Containers extension](https://microsoft.github.io/vscode-remote-release/images/remote-containers-extn.png)
 
-    > Note that the Remote - Containers extension requires the Visual Studio Code distribution of Code - OSS. See the [FAQ](https://aka.ms/vscode-remote/faq/license) for details.
+    > **Note:** The Remote - Containers extension requires the Visual Studio Code distribution of Code - OSS. See the [FAQ](https://aka.ms/vscode-remote/faq/license) for details.
 
-4. Press <kbd>Ctrl/Cmd</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> and select **Remote-Containers: Clone Repository in Container Volume...**.
+4. Press <kbd>Ctrl/Cmd</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> or <kbd>F1</kbd> and select **Remote-Containers: Clone Repository in Container Volume...**.
 
-    > **Tip:** While you can use your local source tree instead, operations like `yarn install` can be slow on macOS or using the Hyper-V engine on Windows. We recommend the "clone repository in container" approach instead since it uses "named volume" rather than the local filesystem.
+    > **Tip:** While you can use your local source tree instead, operations like `yarn install` can be slow on macOS or when using the Hyper-V engine on Windows. We recommend the "clone repository in container" approach instead since it uses "named volume" rather than the local filesystem.
 
 5. Type `https://github.com/microsoft/vscode` (or a branch or PR URL) in the input box and press <kbd>Enter</kbd>.
 
-6. After the container is running, open a web browser and go to [http://localhost:6080](http://localhost:6080) or use a [VNC Viewer](https://www.realvnc.com/en/connect/download/viewer/) to connect to `localhost:5901` and enter `vscode` as the password.
+6. After the container is running, open a web browser and go to [http://localhost:6080](http://localhost:6080), or use a [VNC Viewer](https://www.realvnc.com/en/connect/download/viewer/) to connect to `localhost:5901` and enter `vscode` as the password.
 
-Anything you start in VS Code or the integrated terminal will appear here.
+Anything you start in VS Code, or the integrated terminal, will appear here.
 
 Next: **[Try it out!](#try-it)**
 
 ## Quick start - GitHub Codespaces
 
-> **IMPORTANT:** You need to use a "Standard" sized codespace or larger (4-core, 8GB) since VS Code needs 6GB of RAM to compile. This is now the default for GitHub Codespaces, but do not downgrade to "Basic" unless you do not intend to compile.
+1. From the [microsoft/vscode GitHub repository](https://github.com/microsoft/vscode), click on the **Code** dropdown, select **Open with Codespaces**, and then click on **New codespace**. If prompted, select the **Standard** machine size (which is also the default).
 
-1. From the [microsoft/vscode GitHub repository](https://github.com/microsoft/vscode), click on the **Code** dropdown, select **Open with Codespaces**, and the **New codespace**
+   > **Note:** You will not see these options within GitHub if you are not in the Codespaces beta.
 
-    > Note that you will not see these options if you are not in the beta yet.
+2. After the codespace is up and running in your browser, press <kbd>Ctrl/Cmd</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> or <kbd>F1</kbd> and select **Ports: Focus on Ports View**.
 
-2. After the codespace is up and running in your browser, press <kbd>F1</kbd> and select **Ports: Focus on Ports View**.
+3. You should see **VNC web client (6080)** under in the list of ports. Select the line and click on the globe icon to open it in a browser tab.
 
-3. You should see port `6080` under **Forwarded Ports**. Select the line and click on the globe icon to open it in a browser tab.
-
-    > If you do not see port `6080`, press <kbd>F1</kbd>, select **Forward a Port** and enter port `6080`.
+    > **Tip:** If you do not see the port, <kbd>Ctrl/Cmd</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> or <kbd>F1</kbd>, select **Forward a Port** and enter port `6080`.
 
 4. In the new tab, you should see noVNC. Click **Connect** and enter `vscode` as the password.
 
-Anything you start in VS Code or the integrated terminal will appear here.
+Anything you start in VS Code, or the integrated terminal, will appear here.
 
 Next: **[Try it out!](#try-it)**
 
 ### Using VS Code with GitHub Codespaces
 
-You will likely see better performance when accessing the codespace you created from VS Code since you can use a[VNC Viewer](https://www.realvnc.com/en/connect/download/viewer/). Here's how to do it.
+You may see improved VNC responsiveness when accessing a codespace from VS Code client since you can use a [VNC Viewer](https://www.realvnc.com/en/connect/download/viewer/). Here's how to do it.
+
+1.  Install [Visual Studio Code Stable](https://code.visualstudio.com/) or [Insiders](https://code.visualstudio.com/insiders/) and the the [GitHub Codespaces extension](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces).
 
-1. [Create a codespace](#quick-start---github-codespaces) if you have not already.
+	> **Note:** The GitHub Codespaces extension requires the Visual Studio Code distribution of Code - OSS.
 
-2. Set up [VS Code for use with GitHub Codespaces](https://docs.github.com/github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code)
+2. After the VS Code is up and running, press <kbd>Ctrl/Cmd</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd> or <kbd>F1</kbd>, choose **Codespaces: Create New Codespace**, and use the following settings:
+    - `microsoft/vscode` for the repository.
+	- Select any branch (e.g. **main**) - you select a different one later.
+	- Choose **Standard** (4-core, 8GB) as the size.
 
-3. After the VS Code is up and running, press <kbd>F1</kbd>, choose **Codespaces: Connect to Codespace**, and select the codespace you created.
+4. After you have connected to the codespace, you can use a [VNC Viewer](https://www.realvnc.com/en/connect/download/viewer/) to connect to `localhost:5901` and enter `vscode` as the password.
 
-4. After you've connected to the codespace, use a [VNC Viewer](https://www.realvnc.com/en/connect/download/viewer/) to connect to `localhost:5901` and enter `vscode` as the password.
+    > **Tip:** You may also need change your VNC client's **Picture Quaility** setting to **High** to get a full color desktop.
 
-5. Anything you start in VS Code or the integrated terminal will appear here.
+5. Anything you start in VS Code, or the integrated terminal, will appear here.
 
 Next: **[Try it out!](#try-it)**
 
 ## Try it!
 
 This container uses the [Fluxbox](http://fluxbox.org/) window manager to keep things lean. **Right-click on the desktop** to see menu options. It works with GNOME and GTK applications, so other tools can be installed if needed.
 
-Note you can also set the resolution from the command line by typing `set-resolution`.
+> **Note:** You can also set the resolution from the command line by typing `set-resolution`.
 
 To start working with Code - OSS, follow these steps:
 
-1. In your local VS Code, open a terminal (<kbd>Ctrl/Cmd</kbd> + <kbd>Shift</kbd> + <kbd>\`</kbd>) and type the following commands:
+1. In your local VS Code client, open a terminal (<kbd>Ctrl/Cmd</kbd> + <kbd>Shift</kbd> + <kbd>\`</kbd>) and type the following commands:
 
     ```bash
     yarn install
     bash scripts/code.sh
     ```
 
-    Note that a previous run of `yarn install`  will already be cached, so this step should simply pick up any recent differences.
-
-2. After the build is complete, open a web browser or a [VNC Viewer](https://www.realvnc.com/en/connect/download/viewer/) to the desktop environnement as described in the quick start and enter `vscode` as the password.
+2. After the build is complete, open a web browser or a [VNC Viewer](https://www.realvnc.com/en/connect/download/viewer/) to connect to the desktop environment as described in the quick start and enter `vscode` as the password.
 
 3. You should now see Code - OSS!
 
 Next, let's try debugging.
 
 1. Shut down Code - OSS by clicking the box in the upper right corner of the Code - OSS window through your browser or VNC viewer.
 
-2. Go to your local VS Code client, and use Run / Debug view to launch the **VS Code** configuration. (Typically the default, so you can likely just press <kbd>F5</kbd>).
+2. Go to your local VS Code client, and use the **Run / Debug** view to launch the **VS Code** configuration. (Typically the default, so you can likely just press <kbd>F5</kbd>).
 
     > **Note:** If launching times out, you can increase the value of `timeout` in the "VS Code", "Attach Main Process", "Attach Extension Host", and "Attach to Shared Process" configurations in [launch.json](../.vscode/launch.json). However, running `scripts/code.sh` first will set up Electron which will usually solve timeout issues.
 

.devcontainer/cache/before-cache.sh

@@ -1,11 +1,11 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
-# This file establishes a basline for the reposuitory before any steps in the "prepare.sh"
+# This file establishes a basline for the repository before any steps in the "prepare.sh"
 # are run. Its just a find command that filters out a few things we don't need to watch.
 
 set -e
 
-SCRIPT_PATH="$(cd "$(dirname $0)" && pwd)"
+SCRIPT_PATH="$(cd $(dirname "${BASH_SOURCE[0]}") && pwd)"
 SOURCE_FOLDER="${1:-"."}"
 
 cd "${SOURCE_FOLDER}"

.devcontainer/cache/build-cache-image.sh

@@ -1,12 +1,12 @@
 #!/bin/bash
 
-# This file simply wraps the dockeer build command used to build the image with the
-# cached result of the commands from "prepare.sh" and pushes it to the specified
-# container image registry.
+# This file simply wraps the docker build command to build an image that includes
+# a cache.tar file with the result of "prepare.sh" inside of it. See cache.Dockerfile
+# for the steps that are actually taken to do this.
 
 set -e
 
-SCRIPT_PATH="$(cd "$(dirname $0)" && pwd)"
+SCRIPT_PATH="$(cd $(dirname "${BASH_SOURCE[0]}") && pwd)"
 CONTAINER_IMAGE_REPOSITORY="$1"
 BRANCH="${2:-"main"}"
 

.devcontainer/cache/cache-diff.sh

@@ -1,12 +1,11 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
 # This file is used to archive off a copy of any differences in the source tree into another location
-# in the image. Once the codespace is up, this will be restored into its proper location (which is
-# quick and happens parallel to other startup activities)
+# in the image. Once the codespace / container is up, this will be restored into its proper location.
 
 set -e
 
-SCRIPT_PATH="$(cd "$(dirname $0)" && pwd)"
+SCRIPT_PATH="$(cd $(dirname "${BASH_SOURCE[0]}") && pwd)"
 SOURCE_FOLDER="${1:-"."}"
 CACHE_FOLDER="${2:-"/usr/local/etc/devcontainer-cache"}"
 

.devcontainer/cache/cache.Dockerfile

@@ -1,7 +1,8 @@
-# This dockerfile is used to build up from a base image to create an image with cached results of running "prepare.sh".
+# This dockerfile is used to build up from a base image to create an image a cache.tar file containing the results of running "prepare.sh".
 # Other image contents: https://github.com/microsoft/vscode-dev-containers/blob/master/repository-containers/images/github.com/microsoft/vscode/.devcontainer/base.Dockerfile
-FROM mcr.microsoft.com/vscode/devcontainers/repos/microsoft/vscode:dev
 
+# This first stage generates cache.tar
+FROM mcr.microsoft.com/vscode/devcontainers/repos/microsoft/vscode:dev as cache
 ARG USERNAME=node
 COPY --chown=${USERNAME}:${USERNAME} . /repo-source-tmp/
 RUN mkdir /usr/local/etc/devcontainer-cache \
@@ -10,5 +11,12 @@ RUN mkdir /usr/local/etc/devcontainer-cache \
 		cd /repo-source-tmp \
 		&& .devcontainer/cache/before-cache.sh \
 		&& .devcontainer/prepare.sh \
-		&& .devcontainer/cache/cache-diff.sh" \
-	&& rm -rf /repo-source-tmp
+		&& .devcontainer/cache/cache-diff.sh"
+
+# This second stage starts fresh and just copies in cache.tar from the previous stage. The related
+# devcontainer.json file is then setup to have postCreateCommand fire restore-diff.sh to expand it.
+FROM mcr.microsoft.com/vscode/devcontainers/repos/microsoft/vscode:dev as dev-container
+ARG USERNAME=node
+ARG CACHE_FOLDER="/usr/local/etc/devcontainer-cache"
+RUN mkdir -p "${CACHE_FOLDER}" && chown "${USERNAME}:${USERNAME}" "${CACHE_FOLDER}"
+COPY --from=cache ${CACHE_FOLDER}/cache.tar ${CACHE_FOLDER}/

.devcontainer/cache/restore-diff.sh

@@ -1,9 +1,8 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
-# This file restores the results of the "prepare.sh" into their proper locations
-# once the container has been created. It runs as a postCreateCommand which
-# in GitHub Codespaces occurs parallel to other startup activities and does not
-# really add to the overal startup time given how quick the operation ends up being.
+# This file expands the cache.tar file in the image that contains the results of "prepare.sh"
+# on top of the source tree. It runs as a postCreateCommand which runs after the container/codespace
+# is already up where you would typically run a command like "yarn install".
 
 set -e
 

.devcontainer/devcontainer.json

@@ -3,28 +3,38 @@
 
 	// Image contents: https://github.com/microsoft/vscode-dev-containers/blob/master/repository-containers/images/github.com/microsoft/vscode/.devcontainer/base.Dockerfile
 	"image": "mcr.microsoft.com/vscode/devcontainers/repos/microsoft/vscode:branch-main",
-
-	"workspaceMount": "source=${localWorkspaceFolder},target=/home/node/workspace/vscode,type=bind,consistency=cached",
-	"workspaceFolder": "/home/node/workspace/vscode",
 	"overrideCommand": false,
 	"runArgs": [ "--init", "--security-opt", "seccomp=unconfined"],
 
 	"settings": {
-		"terminal.integrated.shell.linux": "/bin/bash",
 		"resmon.show.battery": false,
 		"resmon.show.cpufreq": false
 	},
 
-	// noVNC, VNC, debug ports
-	"forwardPorts": [6080, 5901, 9222],
+	// noVNC, VNC
+	"forwardPorts": [6080, 5901],
+	"portsAttributes": {
+		"6080": {
+			"label": "VNC web client (noVNC)",
+			"onAutoForward": "silent"
+		},
+		"5901": {
+			"label": "VNC TCP port",
+			"onAutoForward": "silent"
+		}
+	},
 
 	"extensions": [
 		"dbaeumer.vscode-eslint",
 		"mutantdino.resourcemonitor"
 	],
 
 	// Optionally loads a cached yarn install for the repo
-	"postCreateCommand": ".devcontainer/cache/restore-diff.sh",
+	"postCreateCommand": ".devcontainer/cache/restore-diff.sh && sudo chown node:node /workspaces",
+
+	"remoteUser": "node",
 
-	"remoteUser": "node"
+	"hostRequirements": {
+		"memory": "6gb"
+	}
 }

.devcontainer/prepare.sh

@@ -1,10 +1,9 @@
-#!/bin/bash
+#!/usr/bin/env bash
 
-# This file contains the steps that should be run when creating the intermediary image that contains
-# contents for that should be in the image by default. It will be used to build up from the base image
-# to create an image that speeds up first time use of the dev container by "caching" the results
-# of these commands. Developers can still run these commands without an issue once the container is
-# up, but only differences will be processed which also speeds up the first time these operations occur.
+# This file contains the steps that should be run when building a "cache" image with contents that should be
+# layered directly **on top of the source tree** once a dev container is created. This avoids having to run long
+# running commands like "yarn install" from the ground up. Developers (and should) still run these commands
+# after the actual dev container is created, but only differences will be processed.
 
 yarn install
 yarn electron

.eslintignore

@@ -3,7 +3,7 @@
 **/vs/css.build.js
 **/vs/css.js
 **/vs/loader.js
-**/insane/**
+**/dompurify/**
 **/marked/**
 **/semver/**
 **/test/**/*.js
@@ -16,3 +16,8 @@
 **/extensions/markdown-language-features/notebook-out/**
 **/extensions/typescript-basics/test/colorize-fixtures/**
 **/extensions/**/dist/**
+**/extensions/typescript-language-features/test-workspace/**
+
+# These files are not linted by `yarn eslint`, so we exclude them from being linted in the editor.
+# This ensures that if we add new rules and they pass CI, there are also no errors in the editor.
+/resources/web/code-web.js