From 21d3062bf9825432835f17023743b1e1e6c36960 Mon Sep 17 00:00:00 2001
From: Teffen Ellis <teffen@nirri.us>
Date: Wed, 28 Jul 2021 14:11:33 -0400
Subject: [PATCH] Touch up names.

---
 src/node/{vscode.ts => provider.ts} |  5 +++++
 src/node/routes/vscode.ts           | 12 +++++++-----
 2 files changed, 12 insertions(+), 5 deletions(-)
 rename src/node/{vscode.ts => provider.ts} (97%)

diff --git a/src/node/vscode.ts b/src/node/provider.ts
similarity index 97%
rename from src/node/vscode.ts
rename to src/node/provider.ts
index 2630a194..1a231235 100644
--- a/src/node/vscode.ts
+++ b/src/node/provider.ts
@@ -10,6 +10,11 @@ import { SocketProxyProvider } from "./socket"
 import { isFile } from "./util"
 import { onMessage, wrapper } from "./wrapper"
 
+/**
+ * Provides an interface to manage a child VS Code process.
+ *
+ * @remark This shouldn't be confused with the actual child process.
+ */
 export class VscodeProvider {
   public readonly serverRootPath: string
   public readonly vsRootPath: string
diff --git a/src/node/routes/vscode.ts b/src/node/routes/vscode.ts
index 9179b241..0cd55fd5 100644
--- a/src/node/routes/vscode.ts
+++ b/src/node/routes/vscode.ts
@@ -10,13 +10,13 @@ import { getFirstString } from "../../common/util"
 import { Feature } from "../cli"
 import { isDevMode, rootPath, version } from "../constants"
 import { authenticated, ensureAuthenticated, redirect, replaceTemplates } from "../http"
+import { VscodeProvider } from "../provider"
 import { getMediaMime, pathToFsPath } from "../util"
-import { VscodeProvider } from "../vscode"
 import { Router as WsRouter } from "../wsRouter"
 
 export const router = Router()
 
-const vscode = new VscodeProvider()
+const vscodeProvider = new VscodeProvider()
 
 router.get("/", async (req, res) => {
   const isAuthenticated = await authenticated(req)
@@ -31,7 +31,7 @@ router.get("/", async (req, res) => {
     await fs.readFile(path.join(rootPath, "src/browser/pages/vscode.html"), "utf8"),
     (async () => {
       try {
-        return await vscode.initialize({ args: req.args, remoteAuthority: req.headers.host || "" }, req.query)
+        return await vscodeProvider.initialize({ args: req.args, remoteAuthority: req.headers.host || "" }, req.query)
       } catch (error) {
         const devMessage = isDevMode ? "It might not have finished compiling." : ""
         throw new Error(`VS Code failed to load. ${devMessage} ${error.message}`)
@@ -91,7 +91,9 @@ router.get("/webview/*", ensureAuthenticated, async (req, res) => {
     return res.send(await fs.readFile(req.params[0].replace(/^vscode-resource(\/file)?/, "")))
   }
   return res.send(
-    await fs.readFile(path.join(vscode.vsRootPath, "out/vs/workbench/contrib/webview/browser/pre", req.params[0])),
+    await fs.readFile(
+      path.join(vscodeProvider.vsRootPath, "out/vs/workbench/contrib/webview/browser/pre", req.params[0]),
+    ),
   )
 })
 
@@ -228,5 +230,5 @@ wsRouter.ws("/", ensureAuthenticated, async (req) => {
 
   req.ws.write(responseHeaders.join("\r\n") + "\r\n\r\n")
 
-  await vscode.sendWebsocket(req.ws, req.query, useCompression)
+  await vscodeProvider.sendWebsocket(req.ws, req.query, useCompression)
 })