Clean up and refactor VSCode integration.

- Fixed linter/prettier mixups during development.
- Cleaned up web config injection, removed separate NLS injection.
- Cleaned up comments for use with intellisense
- Updated types to more often use VScode's built in types.
- Cleaned up URI helpers.
- Organized connection classes into separate files.
- Documented protocol usage, adding trace logging support.
- Fleshed out partial support for remote debugging.
- Updated tests.

Author: GirlBossRush

.editorconfig

@@ -3,4 +3,9 @@ root = true
 [*]
 indent_style = space
 trim_trailing_whitespace = true
+
+# The indent size used in the `package.json` file cannot be changed
+# https://github.com/npm/npm/pull/3180#issuecomment-16336516
+[{*.yml,*.yaml,package.json}]
+indent_style = space
 indent_size = 2

.prettierrc.yaml

@@ -2,3 +2,16 @@ printWidth: 120
 semi: false
 trailingComma: all
 arrowParens: always
+singleQuote: false
+useTabs: false
+
+overrides:
+  # Attempt to keep VScode's existing code style intact.
+  - files: "lib/vscode/**/*.ts"
+    options:
+      # No limit defined upstream.
+      printWidth: 10000
+      semi: true
+      singleQuote: true
+      useTabs: true
+      arrowParens: avoid

lib/vscode/.eslintrc.json

@@ -802,12 +802,14 @@
 				"target": "**/vs/server/**",
 				"restrictions": [
 					"vs/nls",
+					// @coder Allow additional imports until our server structure aligns with upstream.
+					"**/vs/code/**/{common,server,browser,node,electron-sandbox,electron-browser}/**",
 					"**/vs/base/**/{common,node}/**",
 					"**/vs/base/parts/**/{common,node}/**",
 					"**/vs/platform/**/{common,node}/**",
 					"**/vs/workbench/**/{common,node}/**",
+					"**/vs/workbench/workbench.web.api",
 					"**/vs/server/**",
-					"@coder/logger", // NOTE@coder: add logger
 					"*" // node modules
 				]
 			},

lib/vscode/.vscode/settings.json

@@ -84,6 +84,13 @@
 		"editor.defaultFormatter": "vscode.typescript-language-features",
 		"editor.formatOnSave": true,
 	},
+	// @coder Attempt to keep loose formatters inline with upstream's code style.
+	"typescript.format.insertSpaceAfterConstructor": false,
+	"javascript.format.insertSpaceAfterConstructor": false,
+	"javascript.format.insertSpaceBeforeFunctionParenthesis": false,
+	"typescript.format.insertSpaceBeforeFunctionParenthesis": false,
+	"typescript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets": false,
+	"javascript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyBrackets": false,
 	"typescript.tsc.autoDetect": "off",
 	"notebook.experimental.useMarkdownRenderer": true,
 	"testing.autoRun.mode": "rerun",

lib/vscode/build/gulpfile.reh.js

@@ -42,8 +42,6 @@ BUILD_TARGETS.forEach(({ platform, arch }) => {
 });
 
 function getNodeVersion() {
-	// NOTE@coder: Fix version due to .yarnrc removal.
-	return process.versions.node;
 	const yarnrc = fs.readFileSync(path.join(REPO_ROOT, 'remote', '.yarnrc'), 'utf8');
 	const target = /^target "(.*)"$/m.exec(yarnrc)[1];
 	return target;

lib/vscode/build/hygiene.js

@@ -19,6 +19,18 @@ const copyrightHeaderLines = [
 	' *--------------------------------------------------------------------------------------------*/',
 ];
 
+/**
+ * @remark While this helps delineate Coder's additions to the upstream project,
+ * this notice should be examined within the context of the application.
+ * Code from both maintainers often overlaps.
+ */
+const coderCopyrightHeaderLines = [
+	'/*---------------------------------------------------------------------------------------------',
+	' *  Copyright (c) Coder Technologies. All rights reserved.',
+	' *  Licensed under the MIT License. See License.txt in the project root for license information.',
+	' *--------------------------------------------------------------------------------------------*/',
+];
+
 function hygiene(some, linting = true) {
 	const gulpeslint = require('gulp-eslint');
 	const tsfmt = require('typescript-formatter');
@@ -62,7 +74,7 @@ function hygiene(some, linting = true) {
 		const lines = file.__lines;
 
 		for (let i = 0; i < copyrightHeaderLines.length; i++) {
-			if (lines[i] !== copyrightHeaderLines[i]) {
+			if (lines[i] !== copyrightHeaderLines[i] && lines[i] !== coderCopyrightHeaderLines[i]) {
 				console.error(file.relative + ': Missing or bad copyright statement');
 				errorCount++;
 				break;

lib/vscode/build/lib/node.js

@@ -8,8 +8,8 @@ const path = require("path");
 const fs = require("fs");
 const root = path.dirname(path.dirname(__dirname));
 const yarnrcPath = path.join(root, 'remote', '.yarnrc');
-// NOTE@coder: Fix version due to .yarnrc removal.
-const version = process.versions.node;
+const yarnrc = fs.readFileSync(yarnrcPath, 'utf8');
+const version = /^target\s+"([^"]+)"$/m.exec(yarnrc)[1];
 const platform = process.platform;
 const arch = platform === 'darwin' ? 'x64' : process.arch;
 const node = platform === 'win32' ? 'node.exe' : 'node';

lib/vscode/build/lib/node.ts

@@ -4,11 +4,13 @@
  *--------------------------------------------------------------------------------------------*/
 
 import * as path from 'path';
+import * as fs from 'fs';
 
 const root = path.dirname(path.dirname(__dirname));
+const yarnrcPath = path.join(root, 'remote', '.yarnrc');
+const yarnrc = fs.readFileSync(yarnrcPath, 'utf8');
+const version = /^target\s+"([^"]+)"$/m.exec(yarnrc)![1];
 
-// NOTE@coder: Fix version due to .yarnrc removal.
-const version = process.versions.node;
 const platform = process.platform;
 const arch = platform === 'darwin' ? 'x64' : process.arch;
 

lib/vscode/build/lib/util.ts

@@ -336,6 +336,7 @@ export function streamToPromise(stream: NodeJS.ReadWriteStream): Promise<void> {
 }
 
 export function getElectronVersion(): string {
-	// NOTE@coder: Fix version due to .yarnrc removal.
-	return process.versions.node;
+	const yarnrc = fs.readFileSync(path.join(root, '.yarnrc'), 'utf8');
+	const target = /^target "(.*)"$/m.exec(yarnrc)![1];
+	return target;
 }

lib/vscode/build/lib/watch/yarn.lock

@@ -148,9 +148,9 @@ fsevents@~2.3.1:
   integrity sha512-YR47Eg4hChJGAB1O3yEAOkGO+rlzutoICGqGo9EZ4lKWokzZRSyIW1QmTzqjtw8MJdj9srP869CuWw/hyzSiBw==
 
 glob-parent@^5.1.1, glob-parent@~5.1.0:
-  version "5.1.2"
-  resolved "https://registry.yarnpkg.com/glob-parent/-/glob-parent-5.1.2.tgz#869832c58034fe68a4093c17dc15e8340d8401c4"
-  integrity sha512-AOIgSQCepiJYwP3ARnGx+5VnTu2HBYdzbGP45eLw1vr3zB3vZLeyed1sC9hnbcOc9/SrMyM5RPQrkGz4aS9Zow==
+  version "5.1.1"
+  resolved "https://registry.yarnpkg.com/glob-parent/-/glob-parent-5.1.1.tgz#b6c1ef417c4e5663ea498f1c45afac6916bbc229"
+  integrity sha512-FnI+VGOpnlGHWZxthPGR+QhR78fuiK0sNLkHQv+bL9fQi57lNNdquIbna/WrfROrolq8GK5Ek6BiMwqL/voRYQ==
   dependencies:
     is-glob "^4.0.1"