Lint

Author: Katie Horne

docs/CONTRIBUTING.md

@@ -2,20 +2,19 @@
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 # Contributing
 
-- [Contributing](#contributing)
-  - [Requirements](#requirements)
-  - [Creating pull requests](#creating-pull-requests)
-    - [Commits and commit history](#commits-and-commit-history)
-  - [Development workflow](#development-workflow)
-    - [Update VS Code](#update-vs-code)
-    - [Build](#build)
-    - [Test](#test)
-    - [Unit tests](#unit-tests)
-    - [Integration Tests](#integration-tests)
-    - [End-to-end tests](#end-to-end-tests)
-  - [Structure](#structure)
-    - [Modifying VS Code](#modifying-vs-code)
-    - [Currently Known Issues](#currently-known-issues)
+- [Requirements](#requirements)
+- [Creating pull requests](#creating-pull-requests)
+  - [Commits and commit history](#commits-and-commit-history)
+- [Development workflow](#development-workflow)
+  - [Update VS Code](#update-vs-code)
+  - [Build](#build)
+  - [Test](#test)
+  - [Unit tests](#unit-tests)
+  - [Integration Tests](#integration-tests)
+  - [End-to-end tests](#end-to-end-tests)
+- [Structure](#structure)
+  - [Modifying VS Code](#modifying-vs-code)
+  - [Currently Known Issues](#currently-known-issues)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -75,8 +74,7 @@ yarn watch
 
 ### Update VS Code
 
-Updating VS Code requires `git subtree`. On some RPM-based Linux distros, `git
-subtree` is not included by default and needs to be installed separately. To
+Updating VS Code requires `git subtree`. On some RPM-based Linux distros, `git subtree` is not included by default and needs to be installed separately. To
 install, run `dnf install git-subtree` or `yum install git-subtree`.
 
 To update VS Code:

docs/FAQ.md

@@ -2,33 +2,32 @@
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 # FAQ
 
-- [FAQ](#faq)
-  - [Questions?](#questions)
-  - [How should I expose code-server to the internet?](#how-should-i-expose-code-server-to-the-internet)
-  - [Can I use code-server on the iPad?](#can-i-use-code-server-on-the-ipad)
-  - [How does the config file work?](#how-does-the-config-file-work)
-  - [How do I make my keyboard shortcuts work?](#how-do-i-make-my-keyboard-shortcuts-work)
-  - [Why can't code-server use Microsoft's extension marketplace?](#why-cant-code-server-use-microsofts-extension-marketplace)
-  - [How can I request an extension that's missing from the marketplace?](#how-can-i-request-an-extension-thats-missing-from-the-marketplace)
-  - [How do I install an extension?](#how-do-i-install-an-extension)
-  - [How do I install an extension manually?](#how-do-i-install-an-extension-manually)
-  - [How do I use my own extensions marketplace?](#how-do-i-use-my-own-extensions-marketplace)
-  - [Where are extensions stored?](#where-are-extensions-stored)
-  - [How can I reuse my VS Code configuration?](#how-can-i-reuse-my-vs-code-configuration)
-  - [How does code-server decide what workspace or folder to open?](#how-does-code-server-decide-what-workspace-or-folder-to-open)
-  - [How do I access my Documents/Downloads/Desktop folders in code-server on macOS?](#how-do-i-access-my-documentsdownloadsdesktop-folders-in-code-server-on-macos)
-  - [How do I direct server-side requests through a proxy?](#how-do-i-direct-server-side-requests-through-a-proxy)
-  - [How do I debug issues with code-server?](#how-do-i-debug-issues-with-code-server)
-  - [What is the healthz endpoint?](#what-is-the-healthz-endpoint)
-  - [What is the heartbeat file?](#what-is-the-heartbeat-file)
-  - [How do I change the password?](#how-do-i-change-the-password)
-  - [Can I store my password hashed?](#can-i-store-my-password-hashed)
-  - [Is multi-tenancy possible?](#is-multi-tenancy-possible)
-  - [Can I use Docker in a code-server container?](#can-i-use-docker-in-a-code-server-container)
-  - [How do I disable telemetry?](#how-do-i-disable-telemetry)
-  - [What's the difference between code-server and Theia?](#whats-the-difference-between-code-server-and-theia)
-  - [What's the difference between code-server and VS Code Codespaces?](#whats-the-difference-between-code-server-and-vs-code-codespaces)
-  - [Are there community projects involving code-server?](#are-there-community-projects-involving-code-server)
+- [Questions?](#questions)
+- [How should I expose code-server to the internet?](#how-should-i-expose-code-server-to-the-internet)
+- [Can I use code-server on the iPad?](#can-i-use-code-server-on-the-ipad)
+- [How does the config file work?](#how-does-the-config-file-work)
+- [How do I make my keyboard shortcuts work?](#how-do-i-make-my-keyboard-shortcuts-work)
+- [Why can't code-server use Microsoft's extension marketplace?](#why-cant-code-server-use-microsofts-extension-marketplace)
+- [How can I request an extension that's missing from the marketplace?](#how-can-i-request-an-extension-thats-missing-from-the-marketplace)
+- [How do I install an extension?](#how-do-i-install-an-extension)
+- [How do I install an extension manually?](#how-do-i-install-an-extension-manually)
+- [How do I use my own extensions marketplace?](#how-do-i-use-my-own-extensions-marketplace)
+- [Where are extensions stored?](#where-are-extensions-stored)
+- [How can I reuse my VS Code configuration?](#how-can-i-reuse-my-vs-code-configuration)
+- [How does code-server decide what workspace or folder to open?](#how-does-code-server-decide-what-workspace-or-folder-to-open)
+- [How do I access my Documents/Downloads/Desktop folders in code-server on macOS?](#how-do-i-access-my-documentsdownloadsdesktop-folders-in-code-server-on-macos)
+- [How do I direct server-side requests through a proxy?](#how-do-i-direct-server-side-requests-through-a-proxy)
+- [How do I debug issues with code-server?](#how-do-i-debug-issues-with-code-server)
+- [What is the healthz endpoint?](#what-is-the-healthz-endpoint)
+- [What is the heartbeat file?](#what-is-the-heartbeat-file)
+- [How do I change the password?](#how-do-i-change-the-password)
+- [Can I store my password hashed?](#can-i-store-my-password-hashed)
+- [Is multi-tenancy possible?](#is-multi-tenancy-possible)
+- [Can I use Docker in a code-server container?](#can-i-use-docker-in-a-code-server-container)
+- [How do I disable telemetry?](#how-do-i-disable-telemetry)
+- [What's the difference between code-server and Theia?](#whats-the-difference-between-code-server-and-theia)
+- [What's the difference between code-server and VS Code Codespaces?](#whats-the-difference-between-code-server-and-vs-code-codespaces)
+- [Are there community projects involving code-server?](#are-there-community-projects-involving-code-server)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -63,8 +62,7 @@ The default config defines the following behavior:
 - Enable password authorization
 - Do not use TLS
 
-Each key in the file maps directly to a `code-server` flag (run `code-server
---help` to see a listing of all the flags). Any flags passed to `code-server`
+Each key in the file maps directly to a `code-server` flag (run `code-server --help` to see a listing of all the flags). Any flags passed to `code-server`
 will take priority over the config file.
 
 You can change the config file's location using the `--config` flag or

docs/MAINTAINING.md

@@ -2,17 +2,16 @@
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 # Maintaining
 
-- [Maintaining](#maintaining)
-  - [Workflow](#workflow)
-    - [Milestones](#milestones)
-    - [Triage](#triage)
-    - [Project boards](#project-boards)
-  - [Versioning](#versioning)
-  - [Pull requests](#pull-requests)
-    - [Merge strategies](#merge-strategies)
-    - [Changelog](#changelog)
-  - [Releases](#releases)
-    - [Publishing a release](#publishing-a-release)
+- [Workflow](#workflow)
+  - [Milestones](#milestones)
+  - [Triage](#triage)
+  - [Project boards](#project-boards)
+- [Versioning](#versioning)
+- [Pull requests](#pull-requests)
+  - [Merge strategies](#merge-strategies)
+  - [Changelog](#changelog)
+- [Releases](#releases)
+  - [Publishing a release](#publishing-a-release)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 

docs/guide.md

@@ -1,20 +1,19 @@
 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
-# Setup
-
-- [Setup](#setup)
-  - [Expose code-server](#expose-code-server)
-    - [Port forwarding via SSH](#port-forwarding-via-ssh)
-    - [Using Let's Encrypt with Caddy](#using-lets-encrypt-with-caddy)
-    - [Using Let's Encrypt with NGINX](#using-lets-encrypt-with-nginx)
-    - [Using a self-signed certificate](#using-a-self-signed-certificate)
-  - [External authentication](#external-authentication)
-  - [HTTPS](#https)
-    - [Self Signed Certificate](#self-signed-certificate)
-    - [Using a subdomain](#using-a-subdomain)
-    - [Using a subpath](#using-a-subpath)
-    - [Stripping `/proxy/<port>` from the request path](#stripping-proxyport-from-the-request-path)
-    - [Proxying to create a React app](#proxying-to-create-a-react-app)
+# Setup Guide
+
+- [Expose code-server](#expose-code-server)
+  - [Port forwarding via SSH](#port-forwarding-via-ssh)
+  - [Using Let's Encrypt with Caddy](#using-lets-encrypt-with-caddy)
+  - [Using Let's Encrypt with NGINX](#using-lets-encrypt-with-nginx)
+  - [Using a self-signed certificate](#using-a-self-signed-certificate)
+- [External authentication](#external-authentication)
+- [HTTPS](#https)
+  - [Self Signed Certificate](#self-signed-certificate)
+  - [Using a subdomain](#using-a-subdomain)
+  - [Using a subpath](#using-a-subpath)
+  - [Stripping `/proxy/<port>` from the request path](#stripping-proxyport-from-the-request-path)
+  - [Proxying to create a React app](#proxying-to-create-a-react-app)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -85,8 +84,8 @@ we recommend using another method, such as [Let's Encrypt](#let-encrypt) instead
    # This is the same as the above SSH command, but it runs in the background
    # continuously. Be sure to add `mutagen daemon start` to your ~/.bashrc to
    # start the mutagen daemon when you open a shell.
-
-   mutagen forward create --name=code-server tcp:127.0.0.1:8080 <instance-ip>:tcp:127.0.0.1:8080
+   
+   mutagen forward create --name=code-server tcp:127.0.0.1:8080 < instance-ip > :tcp:127.0.0.1:8080
    ```
 
 6. Optional, but highly recommended: add the following to `~/.ssh/config` so
@@ -111,19 +110,19 @@ access code-server on an iPad or do not want to use SSH port forwarding.
 1. This option requires that the remote machine be exposed to the internet. Make sure that your instance allows HTTP/HTTP traffic.
 
 1. You'll need a domain name (if you don't have one, you can purchase one from
-  [Google Domains](https://domains.google.com) or the domain service of your
-  choice)). Once you have a domain name, add an A record to your domain that contains your
-  instance's IP address.
+   [Google Domains](https://domains.google.com) or the domain service of your
+   choice)). Once you have a domain name, add an A record to your domain that contains your
+   instance's IP address.
 
 1. Install [Caddy](https://caddyserver.com/docs/download#debian-ubuntu-raspbian):
 
-  ```console
-  sudo apt install -y debian-keyring debian-archive-keyring apt-transport-https
-  curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/cfg/gpg/gpg.155B6D79CA56EA34.key' | sudo apt-key add -
-  curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/cfg/setup/config.deb.txt?distro=debian&version=any-version' | sudo tee -a /etc/apt/sources.list.d/caddy-stable.list
-  sudo apt update
-  sudo apt install caddy
-  ```
+```console
+sudo apt install -y debian-keyring debian-archive-keyring apt-transport-https
+curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/cfg/gpg/gpg.155B6D79CA56EA34.key' | sudo apt-key add -
+curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/cfg/setup/config.deb.txt?distro=debian&version=any-version' | sudo tee -a /etc/apt/sources.list.d/caddy-stable.list
+sudo apt update
+sudo apt install caddy
+```
 
 1. Replace `/etc/caddy/Caddyfile` using `sudo` so that the file looks like this:
 
@@ -158,9 +157,9 @@ At this point, you should be able to access code-server via
 1. This option requires that the remote machine be exposed to the internet. Make sure that your instance allows HTTP/HTTP traffic.
 
 1. You'll need a domain name (if you don't have one, you can purchase one from
-  [Google Domains](https://domains.google.com) or the domain service of your
-  choice)). Once you have a domain name, add an A record to your domain that contains your
-  instance's IP address.
+   [Google Domains](https://domains.google.com) or the domain service of your
+   choice)). Once you have a domain name, add an A record to your domain that contains your
+   instance's IP address.
 
 1. Install NGINX:
 
@@ -220,7 +219,7 @@ certificates do not work with iPads and may cause unexpected issues with
 code-server. You should only proceed with this option if:
 
 - You do not want to buy a domain or you cannot expose the remote machine to
-   the internet
+  the internet
 - You do not want to use port forwarding via SSH
 
 To use a self-signed certificate:
@@ -278,7 +277,7 @@ If you pass a certificate to code-server, it will respond to HTTPS requests and
 redirect all HTTP requests to HTTPS.
 
 > You can use [Let's Encrypt](https://letsencrypt.org/) to get a TLS certificate
-for free.
+> for free.
 
 ### Self Signed Certificate
 
@@ -303,7 +302,7 @@ code-server --proxy-domain <domain>
 ```
 
 Now you can browse to `<port>.<domain>`. Note that this uses the host header, so
-ensure your reverse proxy (if you're using one)  forwards that information.
+ensure your reverse proxy (if you're using one) forwards that information.
 
 ### Using a subpath
 

docs/install.md

@@ -2,37 +2,19 @@
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 # Install
 
-<<<<<<< HEAD
-- [Install](#install)
-  - [install.sh](#installsh)
-    - [Detection reference](#detection-reference)
-  - [yarn, npm](#yarn-npm)
-  - [Standalone releases](#standalone-releases)
-  - [Debian, Ubuntu](#debian-ubuntu)
-  - [Fedora, CentOS, RHEL, SUSE](#fedora-centos-rhel-suse)
-  - [Arch Linux](#arch-linux)
-  - [macOS](#macos)
-  - [Docker](#docker)
-  - [Helm](#helm)
-  - [Raspberry Pi](#raspberry-pi)
-  - [Termux](#termux)
-  - [Cloud providers](#cloud-providers)
-=======
-- [Install](#install)
-  - [install.sh](#installsh)
-    - [Detection reference](#detection-reference)
-  - [yarn, npm](#yarn-npm)
-  - [Standalone releases](#standalone-releases)
-  - [Debian, Ubuntu](#debian-ubuntu)
-  - [Fedora, CentOS, RHEL, SUSE](#fedora-centos-rhel-suse)
-  - [Arch Linux](#arch-linux)
-  - [macOS](#macos)
-  - [Docker](#docker)
-  - [Helm](#helm)
-  - [Raspberry Pi](#raspberry-pi)
-  - [Termux](#termux)
-  - [Cloud providers](#cloud-providers)
->>>>>>> main
+- [install.sh](#installsh)
+  - [Detection reference](#detection-reference)
+- [yarn, npm](#yarn-npm)
+- [Standalone releases](#standalone-releases)
+- [Debian, Ubuntu](#debian-ubuntu)
+- [Fedora, CentOS, RHEL, SUSE](#fedora-centos-rhel-suse)
+- [Arch Linux](#arch-linux)
+- [macOS](#macos)
+- [Docker](#docker)
+- [Helm](#helm)
+- [Raspberry Pi](#raspberry-pi)
+- [Termux](#termux)
+- [Cloud providers](#cloud-providers)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 

docs/ipad.md

@@ -2,16 +2,15 @@
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 # iPad
 
-- [iPad](#ipad)
-  - [Using the code-server progressive web app (PWA)](#using-the-code-server-progressive-web-app-pwa)
-  - [Access code-server with a self-signed certificate on an iPad](#access-code-server-with-a-self-signed-certificate-on-an-ipad)
-    - [Certificate requirements](#certificate-requirements)
-    - [Sharing a self-signed certificate with an iPad](#sharing-a-self-signed-certificate-with-an-ipad)
-  - [Access code-server using Servediter](#access-code-server-using-servediter)
-  - [Raspberry Pi USB-C network](#raspberry-pi-usb-c-network)
-  - [Recommendations](#recommendations)
-  - [Known issues](#known-issues)
-    - [Workaround for issue with `ctrl+c` not stopping a running process in the terminal](#workaround-for-issue-with-ctrlc-not-stopping-a-running-process-in-the-terminal)
+- [Using the code-server progressive web app (PWA)](#using-the-code-server-progressive-web-app-pwa)
+- [Access code-server with a self-signed certificate on an iPad](#access-code-server-with-a-self-signed-certificate-on-an-ipad)
+  - [Certificate requirements](#certificate-requirements)
+  - [Sharing a self-signed certificate with an iPad](#sharing-a-self-signed-certificate-with-an-ipad)
+- [Access code-server using Servediter](#access-code-server-using-servediter)
+- [Raspberry Pi USB-C network](#raspberry-pi-usb-c-network)
+- [Recommendations](#recommendations)
+- [Known issues](#known-issues)
+  - [Workaround for issue with `ctrl+c` not stopping a running process in the terminal](#workaround-for-issue-with-ctrlc-not-stopping-a-running-process-in-the-terminal)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -72,7 +71,7 @@ To share a self-signed certificate with an iPad:
    the certificate's location in its logs:
 
    ```console
-   [2020-10-30T08:55:45.139Z] info    - Using generated certificate and key for HTTPS: ~/.local/share/code-server/mymbp_local.crt
+   [2020-10-30T08:55:45.139Z] info - Using generated certificate and key for HTTPS: ~/.local/share/code-server/mymbp_local.crt
    ```
 
 2. Send the certificate to the iPad, either by emailing it to yourself or using
@@ -173,8 +172,8 @@ and tricks helpful:
   - See [workaround](#ctrl-c-workaround)
 
 Additionally, see [issues in the code-server repo that are tagged with the iPad
-  label](https://github.com/cdr/code-server/issues?q=is%3Aopen+is%3Aissue+label%3AiPad)
-  for more information.
+label](https://github.com/cdr/code-server/issues?q=is%3Aopen+is%3Aissue+label%3AiPad)
+for more information.
 
 ### Workaround for issue with `ctrl+c` not stopping a running process in the terminal
 
@@ -199,4 +198,4 @@ In the meantime, you can manually define a shortcut as a workaround:
    }
    ```
 
-*Source: [StackOverflow](https://stackoverflow.com/a/52735954/3015595)*
+_Source: [StackOverflow](https://stackoverflow.com/a/52735954/3015595)_

docs/npm.md

@@ -2,14 +2,13 @@
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 # npm Install Requirements
 
-- [npm Install Requirements](#npm-install-requirements)
-  - [Node.js version](#nodejs-version)
-  - [Ubuntu, Debian](#ubuntu-debian)
-  - [Fedora, CentOS, RHEL](#fedora-centos-rhel)
-  - [Alpine](#alpine)
-  - [macOS](#macos)
-  - [FreeBSD](#freebsd)
-  - [Issues with Node.js after version upgrades](#issues-with-nodejs-after-version-upgrades)
+- [Node.js version](#nodejs-version)
+- [Ubuntu, Debian](#ubuntu-debian)
+- [Fedora, CentOS, RHEL](#fedora-centos-rhel)
+- [Alpine](#alpine)
+- [macOS](#macos)
+- [FreeBSD](#freebsd)
+- [Issues with Node.js after version upgrades](#issues-with-nodejs-after-version-upgrades)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
@@ -77,8 +76,7 @@ directory and running `npm rebuild` to recompile the modules.
 A step-by-step example of how you might do this is:
 
 1. Install code-server: `brew install code-server`
-2. Navigate into the directory: `cd
-   /usr/local/Cellar/code-server/<version>/libexec/lib/vscode/`
+2. Navigate into the directory: `cd /usr/local/Cellar/code-server/<version>/libexec/lib/vscode/`
 3. Recompile the native modules: `npm rebuild`
 4. Restart code-server