build: output all build artifacts to dist directory

This commit refactors the build system to output all build artifacts to
the `dist` directory. With this change, we make this repository a monorepo
so that code in `common` directory can be used seamlessly in `client` and
`server`.

Author: kyliau

.gitignore

@@ -2,18 +2,10 @@
 .vscode-test
 .DS_Store
 node_modules
-client/node_modules/
-client/out/
-common/out
 server/node_modules/
-server/out
-integration/out
 dist/
 **/.idea/
 **/tsconfig.tsbuildinfo
 .vscode/settings.json
 .vimrc
 .nvimrc
-syntaxes/out
-syntaxes/test/*.js
-syntaxes/test/*.map

.vscode/launch.json

@@ -8,7 +8,7 @@
       "name": "Launch Client",
       "runtimeExecutable": "${execPath}",
       "args": ["--extensionDevelopmentPath=${workspaceRoot}"],
-      "outFiles": ["${workspaceRoot}/client/out/**/*.js"],
+      "outFiles": ["${workspaceRoot}/dist/client/*.js"],
       "preLaunchTask": {
         "type": "npm",
         "script": "watch"
@@ -20,7 +20,7 @@
       "name": "Attach to Server",
       "port": 6009,
       "restart": true,
-      "outFiles": ["${workspaceRoot}/server/out/**/*.js"]
+      "outFiles": ["${workspaceRoot}/dist/server/*.js"]
     },
     {
       "name": "Language Server E2E Test",
@@ -29,10 +29,10 @@
       "runtimeExecutable": "${execPath}",
       "args": [
         "--extensionDevelopmentPath=${workspaceRoot}",
-        "--extensionTestsPath=${workspaceRoot}/integration/out/e2e",
+        "--extensionTestsPath=${workspaceRoot}/dist/integration/e2e",
         "${workspaceRoot}/integration/project"
       ],
-      "outFiles": ["${workspaceRoot}/integration/out/e2e/*.js"],
+      "outFiles": ["${workspaceRoot}/dist/integration/e2e/*.js"],
       "preLaunchTask": {
         "type": "npm",
         "script": "compile:integration"

DEVELOPER.md

@@ -1,3 +1,17 @@
+# Monorepo setup
+
+This repository is a monorepo. All build outputs are created in the `dist` directory.
+
+The `dependencies` in root [`package.json`](package.json) must include all production dependencies
+of the client **and** and the server.
+
+The dependencies of the `server` need to be duplicated in the root [`package.json`](package.json).
+Therefore, if a new prod dependency is added to the server, it needs to be
+added to both [`package.json`](package.json) and [`server/package.json`](server/package.json).
+
+Note that we do not install the dependencies in [`server`](server),
+hence there should not be a `yarn.lock` file.
+
 ## Navigating Projects in IDE
 
 This repository contains multiple TypeScript projects, each with its own `tsconfig.json`.

banner.rollup.config.js

@@ -1,8 +1,8 @@
 module.exports = [
   {
-    input: 'server/out/banner/banner.js',
+    input: 'dist/banner/banner.js',
     output: {
-      file: 'server/out/banner/banner.rollup.js',
+      file: 'dist/banner/banner.rollup.js',
       format: 'cjs',
     },
     external: [

client/language-configuration.json

@@ -8,7 +8,7 @@
 
 import * as vscode from 'vscode';
 import * as lsp from 'vscode-languageclient';
-import {ServerOptions} from '../../common/out/initialize';
+import {ServerOptions} from '../common/initialize';
 
 /**
  * Represent a vscode command with an ID and an impl function `execute`.

client/package.json

@@ -11,7 +11,7 @@ import * as path from 'path';
 import * as vscode from 'vscode';
 import * as lsp from 'vscode-languageclient';
 
-import * as notification from '../../common/out/notifications';
+import * as notification from '../common/notifications';
 
 import {resolveAndRunNgcc} from './command-ngcc';
 import {registerCommands} from './commands';
@@ -173,7 +173,7 @@ function getServerOptions(ctx: vscode.ExtensionContext, debug: boolean): lsp.Nod
 
   // Node module for the language server
   const prodBundle = ctx.asAbsolutePath('server');
-  const devBundle = ctx.asAbsolutePath(path.join('server', 'out', 'server.js'));
+  const devBundle = ctx.asAbsolutePath(path.join('dist', 'server', 'server.js'));
 
   // Argv options for Node.js
   const prodExecArgv: string[] = [];

client/src/commands.ts

@@ -1,7 +1,8 @@
 {
   "extends": "../tsconfig.json",
   "compilerOptions": {
-    "outDir": "out"
+    "outDir": "../dist/client",
+    "rootDirs": [".", "../dist"]
   },
   "references": [
     {"path": "../common"}

client/src/extension.ts

@@ -2,33 +2,3 @@
 # yarn lockfile v1
 
 
-semver@^6.3.0:
-  version "6.3.0"
-  resolved "https://registry.yarnpkg.com/semver/-/semver-6.3.0.tgz#ee0a64c8af5e8ceea67687b133761e1becbd1d3d"
-  integrity sha512-b39TBaTSfV6yBrapU89p5fKekE2m/NwnDocOVruQFS1/veMgdzuPcnOM34M6CwxW8jH/lxEa5rBoDeUwu5HHTw==
-
-vscode-jsonrpc@^5.0.1:
-  version "5.0.1"
-  resolved "https://registry.yarnpkg.com/vscode-jsonrpc/-/vscode-jsonrpc-5.0.1.tgz#9bab9c330d89f43fc8c1e8702b5c36e058a01794"
-  integrity sha512-JvONPptw3GAQGXlVV2utDcHx0BiY34FupW/kI6mZ5x06ER5DdPG/tXWMVHjTNULF5uKPOUUD0SaXg5QaubJL0A==
-
-[email protected]:
-  version "6.1.3"
-  resolved "https://registry.yarnpkg.com/vscode-languageclient/-/vscode-languageclient-6.1.3.tgz#c979c5bb5855714a0307e998c18ca827c1b3953a"
-  integrity sha512-YciJxk08iU5LmWu7j5dUt9/1OLjokKET6rME3cI4BRpiF6HZlusm2ZwPt0MYJ0lV5y43sZsQHhyon2xBg4ZJVA==
-  dependencies:
-    semver "^6.3.0"
-    vscode-languageserver-protocol "^3.15.3"
-
-vscode-languageserver-protocol@^3.15.3:
-  version "3.15.3"
-  resolved "https://registry.yarnpkg.com/vscode-languageserver-protocol/-/vscode-languageserver-protocol-3.15.3.tgz#3fa9a0702d742cf7883cb6182a6212fcd0a1d8bb"
-  integrity sha512-zrMuwHOAQRhjDSnflWdJG+O2ztMWss8GqUUB8dXLR/FPenwkiBNkMIJJYfSN6sgskvsF0rHAoBowNQfbyZnnvw==
-  dependencies:
-    vscode-jsonrpc "^5.0.1"
-    vscode-languageserver-types "3.15.1"
-
-[email protected]:
-  version "3.15.1"
-  resolved "https://registry.yarnpkg.com/vscode-languageserver-types/-/vscode-languageserver-types-3.15.1.tgz#17be71d78d2f6236d414f0001ce1ef4d23e6b6de"
-  integrity sha512-+a9MPUQrNGRrGU630OGbYVQ+11iOIovjCkqxajPa9w57Sd5ruK8WQNsslzpa0x/QJqC8kRc2DUxWjIFwoNm4ZQ==