build: switch to esbuild for all compilation

This commit configures the esbuild output of for the banner and server
to be in a format that will work for the extension. It mimics the sort
of behavior that we would get in the amd format (which is not supported
by esbuild) by simply overriding the built-in `require` function with
the function which is capable of resolving typescript at runtime from
the location passed in via the arguments.

Fixes #1123

Author: atscott

esbuild.js

@@ -1,10 +1,12 @@
 const esbuild = require('esbuild');
 const fs = require('fs');
 
+/** @type esbuild.BuildOptions */
 const defaultOptions = {
   bundle: true,
   platform: 'node',
   logLevel: 'info',
+  format: 'cjs',
 };
 
 /** @type esbuild.BuildOptions */
@@ -20,7 +22,6 @@ const clientConfig = {
     'vscode-languageserver-protocol',
     'vscode-jsonrpc',
   ],
-  format: 'cjs',
   // Do not enable minification. It seems to break the extension on Windows (with WSL). See #1198.
   minify: false,
 };
@@ -33,7 +34,10 @@ const bannerConfig = {
   external: [
     'path',
   ],
-  format: 'cjs',
+  // This is described in more detail in the `server/banner.ts` but this line actually overrides
+  // the built-in `require` function by adding a line at the bottom of the generated banner code
+  // to assign the override function to the `require` name.
+  footer: {js: 'require = requireOverride;'}
 };
 
 /** @type esbuild.BuildOptions */
@@ -49,16 +53,16 @@ const serverConfig = {
     'vscode-uri',
     'vscode-jsonrpc',
   ],
-  // TODO(atscott): Figure out how to use the banner correctly.
-  // iife format produces a `require("typescript/lib/tsserverlibrary");` line but it needs to use
-  // the `define` in the banner to resolve tsserverlibrary.
-  format: 'iife',
 };
 
 async function build() {
   try {
     await esbuild.build(clientConfig);
     await esbuild.build(bannerConfig);
+    await esbuild.build({
+      ...serverConfig,
+      banner: {js: fs.readFileSync('dist/banner/banner.esbuild.js', 'utf8')},
+    });
   } catch (e) {
     console.error(e);
     process.exit(1);

package.json

@@ -136,7 +136,7 @@
   ],
   "main": "./dist/client/extension",
   "scripts": {
-    "compile": "tsc -p server/banner.tsconfig.json && tsc -b && node esbuild.js && rollup -c",
+    "compile": "tsc -p server/banner.tsconfig.json && tsc -b && node esbuild.js",
     "compile:test": "tsc -b server/src/tests && tsc -b client/src/tests",
     "compile:integration": "tsc -b integration",
     "compile:syntaxes-test": "tsc -b syntaxes/test",
@@ -166,8 +166,6 @@
     "esbuild": "^0.9.0",
     "jasmine": "3.6.4",
     "prettier": "2.2.1",
-    "rollup": "2.38.5",
-    "rollup-plugin-commonjs": "10.1.0",
     "tslint": "6.1.3",
     "tslint-eslint-rules": "5.4.0",
     "vsce": "1.85.0",
@@ -180,4 +178,4 @@
     "type": "git",
     "url": "https://github.com/angular/vscode-ng-language-service"
   }
-}
+}

rollup.config.js

@@ -1,23 +1,32 @@
 import {parseCommandLine} from './cmdline_utils';
 import {resolveTsServer} from './version_provider';
 
+const originalRequire = require;
+
 /**
- * This method provides a custom implementation for the AMD loader to resolve
- * `typescript` module at runtime.
- * @param modules modules to resolve
- * @param cb function to invoke with resolved modules
+ * This method provides a custom implementation for the require function to resolve
+ * `typescript` module at runtime. We provide this as an override to the built-in
+ * 'require' method using the banner funcionality of esbuild. That is, esbuild will
+ * compile the server and add this banner to the top of the compilation so any place
+ * in the server code that uses `require` will get routed through this override.
+ *
+ * Refer also to `esbuild.js`, the `bannerConfig` which overrides the `require` using
+ * the `footer` option, and the `serverConfig` which provides the banner code at the top
+ * of the server output using the `banner` option.
+ *
+ * @param moduleName The module to resolve
+ * @returns
  */
-export function define(modules: string[], cb: (...modules: any[]) => void) {
+export function requireOverride(moduleName: string) {
   const TSSERVER = 'typescript/lib/tsserverlibrary';
-  const resolvedModules = modules.map(m => {
-    if (m === 'typescript') {
-      throw new Error(`Import '${TSSERVER}' instead of 'typescript'`);
-    }
-    if (m === TSSERVER) {
-      const {tsProbeLocations} = parseCommandLine(process.argv);
-      m = resolveTsServer(tsProbeLocations).resolvedPath;
-    }
-    return require(m);
-  });
-  cb(...resolvedModules);
+  if (moduleName === 'typescript') {
+    throw new Error(`Import '${TSSERVER}' instead of 'typescript'`);
+  }
+  if (moduleName === TSSERVER) {
+    const {tsProbeLocations} = parseCommandLine(process.argv);
+    moduleName = resolveTsServer(tsProbeLocations).resolvedPath;
+  }
+  return originalRequire(moduleName);
 }
+
+requireOverride.resolve = originalRequire.resolve;

server/src/banner.ts

@@ -33,11 +33,6 @@
   resolved "https://registry.yarnpkg.com/@tootallnate/once/-/once-1.1.2.tgz#ccb91445360179a04e7fe6aff78c00ffc1eeaf82"
   integrity sha512-RbzJvlNzmRq5c3O09UipeuXno4tA1FE6ikOjxZK0tuxVv3412l64l5t1W5pj4+rJq9vpkm/kwiR07aZXnsKPxw==
 
-"@types/estree@*":
-  version "0.0.46"
-  resolved "https://registry.yarnpkg.com/@types/estree/-/estree-0.0.46.tgz#0fb6bfbbeabd7a30880504993369c4bf1deab1fe"
-  integrity sha512-laIjwTQaD+5DukBZaygQ79K1Z0jb1bPEMRrkXSLjtCcZm+abyp5YbrqpSLzD42FwWW6gK/aS4NYpJ804nG2brg==
-
 "@types/[email protected]":
   version "3.6.3"
   resolved "https://registry.yarnpkg.com/@types/jasmine/-/jasmine-3.6.3.tgz#824df555b8a5114f91619e78d8f59624d6f23050"
@@ -346,11 +341,6 @@ esprima@^4.0.0:
   resolved "https://registry.yarnpkg.com/esprima/-/esprima-4.0.1.tgz#13b04cdb3e6c5d19df91ab6987a8695619b0aa71"
   integrity sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A==
 
-estree-walker@^0.6.1:
-  version "0.6.1"
-  resolved "https://registry.yarnpkg.com/estree-walker/-/estree-walker-0.6.1.tgz#53049143f40c6eb918b23671d1fe3219f3a1b362"
-  integrity sha512-SqmZANLWS0mnatqbSfRP5g8OXZC12Fgg1IwNtLsyHDzJizORW4khDfjPqJZsemPWBB2uqykUah5YpQ6epsqC/w==
-
 esutils@^1.1.6:
   version "1.1.6"
   resolved "https://registry.yarnpkg.com/esutils/-/esutils-1.1.6.tgz#c01ccaa9ae4b897c6d0c3e210ae52f3c7a844375"
@@ -368,11 +358,6 @@ fs.realpath@^1.0.0:
   resolved "https://registry.yarnpkg.com/fs.realpath/-/fs.realpath-1.0.0.tgz#1504ad2523158caa40db4a2787cb01411994ea4f"
   integrity sha1-FQStJSMVjKpA20onh8sBQRmU6k8=
 
-fsevents@~2.3.1:
-  version "2.3.2"
-  resolved "https://registry.yarnpkg.com/fsevents/-/fsevents-2.3.2.tgz#8a526f78b8fdf4623b709e0b975c52c24c02fd1a"
-  integrity sha512-xiqMQR4xAeHTuB9uWm+fFRcIOgKBMiOBP+eXiyT7jsgVCq1bkVygt00oASowB7EdtpOHaaPgKt812P9ab+DDKA==
-
 function-bind@^1.1.1:
   version "1.1.1"
   resolved "https://registry.yarnpkg.com/function-bind/-/function-bind-1.1.1.tgz#a56899d3ea3c9bab874bb9773b7c5ede92f4895d"
@@ -482,20 +467,13 @@ inherits@2, inherits@^2.0.1, inherits@^2.0.3:
   resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.4.tgz#0fa2c64f932917c3433a0ded55363aae37416b7c"
   integrity sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==
 
-is-core-module@^2.1.0, is-core-module@^2.2.0:
+is-core-module@^2.1.0:
   version "2.2.0"
   resolved "https://registry.yarnpkg.com/is-core-module/-/is-core-module-2.2.0.tgz#97037ef3d52224d85163f5597b2b63d9afed981a"
   integrity sha512-XRAfAdyyY5F5cOXn7hYQDqh2Xmii+DEfIcQGxK/uNwMHhIkPWO0g8msXcbzLe+MpGoR951MlqM/2iIlU4vKDdQ==
   dependencies:
     has "^1.0.3"
 
-is-reference@^1.1.2:
-  version "1.2.1"
-  resolved "https://registry.yarnpkg.com/is-reference/-/is-reference-1.2.1.tgz#8b2dac0b371f4bc994fdeaba9eb542d03002d0b7"
-  integrity sha512-U82MsXXiFIrjCK4otLT+o2NA2Cd2g5MLoOVXUZjIOhLurrRxpEXzI8O0KZHr3IjLvlAH1kTPYSuqer5T9ZVBKQ==
-  dependencies:
-    "@types/estree" "*"
-
 [email protected]:
   version "0.0.1"
   resolved "https://registry.yarnpkg.com/isarray/-/isarray-0.0.1.tgz#8a18acfca9a8f4177e09abfc6038939b05d1eedf"
@@ -551,13 +529,6 @@ lru-cache@^6.0.0:
   dependencies:
     yallist "^4.0.0"
 
-magic-string@^0.25.2:
-  version "0.25.7"
-  resolved "https://registry.yarnpkg.com/magic-string/-/magic-string-0.25.7.tgz#3f497d6fd34c669c6798dcb821f2ef31f5445051"
-  integrity sha512-4CrMT5DOHTDk4HYDlzmwu4FVCcIYI8gauveasrdCu2IKIFOJ3f0v/8MDGJCDL9oD2ppz/Av1b0Nj345H9M+XIA==
-  dependencies:
-    sourcemap-codec "^1.4.4"
-
 markdown-it@^10.0.0:
   version "10.0.0"
   resolved "https://registry.yarnpkg.com/markdown-it/-/markdown-it-10.0.0.tgz#abfc64f141b1722d663402044e43927f1f50a8dc"
@@ -754,39 +725,6 @@ resolve@^1.1.6, resolve@^1.3.2:
     is-core-module "^2.1.0"
     path-parse "^1.0.6"
 
-resolve@^1.11.0:
-  version "1.20.0"
-  resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.20.0.tgz#629a013fb3f70755d6f0b7935cc1c2c5378b1975"
-  integrity sha512-wENBPt4ySzg4ybFQW2TT1zMQucPK95HSh/nq2CFTZVOGut2+pQvSsgtda4d26YrYcr067wjbmzOG8byDPBX63A==
-  dependencies:
-    is-core-module "^2.2.0"
-    path-parse "^1.0.6"
-
-[email protected]:
-  version "10.1.0"
-  resolved "https://registry.yarnpkg.com/rollup-plugin-commonjs/-/rollup-plugin-commonjs-10.1.0.tgz#417af3b54503878e084d127adf4d1caf8beb86fb"
-  integrity sha512-jlXbjZSQg8EIeAAvepNwhJj++qJWNJw1Cl0YnOqKtP5Djx+fFGkp3WRh+W0ASCaFG5w1jhmzDxgu3SJuVxPF4Q==
-  dependencies:
-    estree-walker "^0.6.1"
-    is-reference "^1.1.2"
-    magic-string "^0.25.2"
-    resolve "^1.11.0"
-    rollup-pluginutils "^2.8.1"
-
-rollup-pluginutils@^2.8.1:
-  version "2.8.2"
-  resolved "https://registry.yarnpkg.com/rollup-pluginutils/-/rollup-pluginutils-2.8.2.tgz#72f2af0748b592364dbd3389e600e5a9444a351e"
-  integrity sha512-EEp9NhnUkwY8aif6bxgovPHMoMoNr2FulJziTndpt5H9RdwC47GSGuII9XxpSdzVGM0GWrNPHV6ie1LTNJPaLQ==
-  dependencies:
-    estree-walker "^0.6.1"
-
-[email protected]:
-  version "2.38.5"
-  resolved "https://registry.yarnpkg.com/rollup/-/rollup-2.38.5.tgz#be41ad4fe0c103a8794377afceb5f22b8f603d6a"
-  integrity sha512-VoWt8DysFGDVRGWuHTqZzT02J0ASgjVq/hPs9QcBOGMd7B+jfTr/iqMVEyOi901rE3xq+Deq66GzIT1yt7sGwQ==
-  optionalDependencies:
-    fsevents "~2.3.1"
-
 safe-buffer@~5.2.0:
   version "5.2.1"
   resolved "https://registry.yarnpkg.com/safe-buffer/-/safe-buffer-5.2.1.tgz#1eaf9fa9bdb1fdd4ec75f58f9cdb4e6b7827eec6"
@@ -817,11 +755,6 @@ source-map@^0.6.0:
   resolved "https://registry.yarnpkg.com/source-map/-/source-map-0.6.1.tgz#74722af32e9614e9c287a8d0bbde48b5e2f1a263"
   integrity sha512-UjgapumWlbMhkBgzT7Ykc5YXUT46F0iKu8SGXq0bcwP5dz/h0Plj6enJqjz1Zbq2l5WaqYnrVbwWOWMyF3F47g==
 
-sourcemap-codec@^1.4.4:
-  version "1.4.8"
-  resolved "https://registry.yarnpkg.com/sourcemap-codec/-/sourcemap-codec-1.4.8.tgz#ea804bd94857402e6992d05a38ef1ae35a9ab4c4"
-  integrity sha512-9NykojV5Uih4lgo5So5dtw+f0JgJX30KCNI8gwhz2J9A15wD0Ml6tjHKwf6fTSa6fAdVBdZeNOs9eJ71qCk8vA==
-
 sprintf-js@~1.0.2:
   version "1.0.3"
   resolved "https://registry.yarnpkg.com/sprintf-js/-/sprintf-js-1.0.3.tgz#04e6926f662895354f3dd015203633b857297e2c"