feat: enable support for typescript references

- add script to build typescript project references
- reorg project layout for better typescript refs
- switch to tsconfig.json
- add copy-resources script

Author: raymondfeng

.gitignore

@@ -29,3 +29,5 @@ packages/tsdocs/fixtures/monorepo/docs
 # ESLint cache
 .eslintcache
 
+# TypeScrip build cache
+.tsbuildinfo

.vscode/tasks.json

@@ -82,13 +82,16 @@
     },
     {
       "label": "Build project",
-      "group": "build",
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      },
       "type": "shell",
       "command": "npm",
       "args": [
         "run",
         "-s",
-        "build"
+        "build:dev"
       ],
       "problemMatcher": "$tsc"
     },

benchmark/package.json

@@ -15,6 +15,7 @@
   },
   "scripts": {
     "build": "lb-tsc es2017 --outDir dist",
+    "build:resources": "lb-copy-resources",
     "clean": "lb-clean dist",
     "pretest": "npm run clean && npm run build",
     "test": "lb-mocha \"dist/__tests__/**/*.js\"",

benchmark/tsconfig.build.json

@@ -0,0 +1,30 @@
+{
+  "$schema": "http://json.schemastore.org/tsconfig",
+  "extends": "../packages/build/config/tsconfig.common.json",
+  "compilerOptions": {
+    "target": "es2017",
+    "outDir": "dist",
+    "rootDir": "src",
+    "composite": true,
+    "incremental": true,
+    "tsBuildInfoFile": ".tsbuildinfo"
+  },
+  "references": [
+    {
+      "path": "../packages/testlab/tsconfig.json"
+    },
+    {
+      "path": "../examples/todo/tsconfig.json"
+    },
+    {
+      "path": "../packages/openapi-spec-builder/tsconfig.json"
+    },
+    {
+      "path": "../packages/rest/tsconfig.json"
+    }
+  ],
+  "include": [
+    "src/**/*",
+    "src/**/*.json"
+  ]
+}

benchmark/tsconfig.json

@@ -0,0 +1,134 @@
+#!/usr/bin/env node
+// Copyright IBM Corp. 2017,2018. All Rights Reserved.
+// Node module: loopback-next
+// This file is licensed under the MIT License.
+// License text available at https://opensource.org/licenses/MIT
+
+/**
+ * This is an internal script to update TypeScript project references based on
+ * lerna's local package dependencies.
+ *
+ * See https://www.typescriptlang.org/docs/handbook/project-references.html
+ */
+'use strict';
+
+const path = require('path');
+const fs = require('fs');
+const util = require('util');
+const debug = require('debug')('loopback:build');
+const buildUtils = require('../packages/build/bin/utils');
+
+const Project = require('@lerna/project');
+const PackageGraph = require('@lerna/package-graph');
+
+const TSCONFIG = 'tsconfig.json';
+
+async function updateReferences(options) {
+  options = options || {};
+  const dryRun = options.dryRun;
+  const project = new Project(process.cwd());
+  const packages = await project.getPackages();
+
+  const rootRefs = [];
+  const graph = new PackageGraph(packages);
+
+  for (const p of graph.values()) {
+    debug('Package %s', p.pkg.name);
+    const pkgLocation = p.pkg.location;
+    const tsconfigFile = path.join(pkgLocation, TSCONFIG);
+    // Skip non-typescript packages
+    if (!fs.existsSync(tsconfigFile)) {
+      debug('Skipping non-TS package: %s', p.pkg.name);
+      continue;
+    }
+    rootRefs.push({
+      path: path.join(path.relative(project.rootPath, pkgLocation), TSCONFIG),
+    });
+    const tsconfig = require(tsconfigFile);
+    const refs = [];
+    for (const d of p.localDependencies.keys()) {
+      const depPkg = graph.get(d);
+      // Skip non-typescript packages
+      if (!fs.existsSync(path.join(depPkg.pkg.location, TSCONFIG))) {
+        debug('Skipping non-TS dependency: %s', depPkg.pkg.name);
+        continue;
+      }
+      const relativePath = path.relative(pkgLocation, depPkg.pkg.location);
+      refs.push({path: path.join(relativePath, TSCONFIG)});
+    }
+    tsconfig.compilerOptions = Object.assign(
+      {
+        // outDir & target have to be set in tsconfig instead of CLI for tsc -b
+        target: buildUtils.getCompilationTarget(),
+        outDir: buildUtils.getDistribution(tsconfig.compilerOptions.target),
+      },
+      tsconfig.compilerOptions,
+      {
+        // composite must be true for project refs
+        composite: true,
+      },
+    );
+    if (options.incremental) {
+      // See https://devblogs.microsoft.com/typescript/announcing-typescript-3-4/#faster-subsequent-builds-with-the---incremental-flag
+      tsconfig.compilerOptions = Object.assign(tsconfig.compilerOptions, {
+        incremental: true,
+        tsBuildInfoFile: '.tsbuildinfo',
+      });
+    }
+
+    if (!tsconfig.include) {
+      // To include ts/json files
+      tsconfig.include = ['src/**/*', 'src/**/*.json'];
+    }
+    tsconfig.references = refs;
+
+    // Convert to JSON
+    const tsconfigJson = JSON.stringify(tsconfig, null, 2);
+
+    if (!dryRun) {
+      // Using `-f` to overwrite tsconfig.json
+      fs.writeFileSync(tsconfigFile, tsconfigJson + '\n', {encoding: 'utf-8'});
+      debug('%s has been updated.', tsconfigFile);
+    } else {
+      // Otherwise write to console
+      debug(tsconfigJson);
+      console.log('%s', p.pkg.name);
+      refs.forEach(r => console.log('  %s', r.path));
+    }
+  }
+
+  const rootTsconfigFile = path.join(project.rootPath, 'tsconfig.json');
+  const rootTsconfig = require(rootTsconfigFile);
+  rootTsconfig.compilerOptions = rootTsconfig.compilerOptions || {};
+  rootTsconfig.compilerOptions.composite = true;
+  rootTsconfig.references = rootRefs;
+
+  // Reset files/include/exclude. The root should use project references now.
+  rootTsconfig.files = [];
+  delete rootTsconfig.include;
+  delete rootTsconfig.exclude;
+
+  // Convert to JSON
+  const rootTsconfigJson = JSON.stringify(rootTsconfig, null, 2);
+  if (!dryRun) {
+    // Using `-f` to overwrite tsconfig.json
+    fs.writeFileSync(rootTsconfigFile, rootTsconfigJson + '\n', {
+      encoding: 'utf-8',
+    });
+    debug('%s has been updated.', rootTsconfigFile);
+    console.log('TypeScript project references have been updated.');
+  } else {
+    debug(rootTsconfigJson);
+    console.log('\n%s', path.relative(project.rootPath, rootTsconfigFile));
+    rootRefs.forEach(r => console.log('  %s', r.path));
+    console.log(
+      '\nThis is a dry-run. Please use -f option to update tsconfig files.',
+    );
+  }
+}
+
+if (require.main === module) {
+  const dryRun = !process.argv.includes('-f');
+  const incremental = process.argv.includes('--incremental');
+  updateReferences({dryRun, incremental});
+}

bin/update-project-refs.js

@@ -7,9 +7,6 @@
   "engines": {
     "node": ">=8.9"
   },
-  "files": [
-    "**/*"
-  ],
   "keywords": [
     "LoopBack",
     "docs"

docs/package.json

@@ -129,7 +129,7 @@ helper method; for example:
 {% include code-caption.html content="src/__tests__/helpers/database.helpers.ts" %}
 
 ```ts
-import {ProductRepository, CategoryRepository} from '../../src/repositories';
+import {ProductRepository, CategoryRepository} from '../../repositories';
 import {testdb} from '../fixtures/datasources/testdb.datasource';
 
 export async function givenEmptyDatabase() {
@@ -547,7 +547,7 @@ valid data to create a new model instance.
 {% include code-caption.html content="src/__tests__/unit/models/person.model.unit.ts" %}
 
 ```ts
-import {Person} from '../../../src/models';
+import {Person} from '../../../models';
 import {givenPersonData} from '../../helpers/database.helpers';
 import {expect} from '@loopback/testlab';
 
@@ -638,7 +638,7 @@ import {
   givenEmptyDatabase,
   givenCategory,
 } from '../../helpers/database.helpers';
-import {CategoryRepository} from '../../../src/repositories';
+import {CategoryRepository} from '../../../repositories';
 import {expect} from '@loopback/testlab';
 import {testdb} from '../../fixtures/datasources/testdb.datasource';
 
@@ -671,8 +671,8 @@ ingredient.
 ```ts
 import {expect} from '@loopback/testlab';
 import {givenEmptyDatabase, givenProduct} from '../../helpers/database.helpers';
-import {ProductController} from '../../../src/controllers';
-import {ProductRepository} from '../../../src/repositories';
+import {ProductController} from '../../../controllers';
+import {ProductRepository} from '../../../repositories';
 import {testdb} from '../../fixtures/datasources/testdb.datasource';
 
 describe('ProductController (integration)', () => {
@@ -719,11 +719,8 @@ of the service proxy by invoking the provider. This helper should be typically
 invoked once before the integration test suite begins.
 
 ```ts
-import {
-  GeoService,
-  GeoServiceProvider,
-} from '../../src/services/geo.service.ts';
-import {GeoDataSource} from '../../src/datasources/geo.datasource.ts';
+import {GeoService, GeoServiceProvider} from '../../services/geo.service.ts';
+import {GeoDataSource} from '../../datasources/geo.datasource.ts';
 
 describe('GeoService', () => {
   let service: GeoService;
@@ -743,7 +740,7 @@ instance:
 
 ```ts
 import {merge} from 'lodash';
-import * as GEO_CODER_CONFIG from '../src/datasources/geo.datasource.json';
+import * as GEO_CODER_CONFIG from '../datasources/geo.datasource.json';
 
 function givenGeoService() {
   const config = merge({}, GEO_CODER_CONFIG, {

docs/site/Testing-your-application.md

@@ -0,0 +1,21 @@
+{
+  "$schema": "http://json.schemastore.org/tsconfig",
+  "extends": "@loopback/build/config/tsconfig.common.json",
+  "compilerOptions": {
+    "target": "es2017",
+    "outDir": "dist",
+    "rootDir": "src",
+    "composite": true
+  },
+  "include": [
+    "src"
+  ],
+  "references": [
+    {
+      "path": "../../packages/testlab/tsconfig.json"
+    },
+    {
+      "path": "../../packages/context/tsconfig.json"
+    }
+  ]
+}

examples/context/tsconfig.build.json

@@ -8,11 +8,13 @@
     "node": ">=8.9"
   },
   "author": "IBM Corp.",
+  "types": "./dist/index.d.ts",
   "scripts": {
     "acceptance": "lb-mocha \"dist/__tests__/acceptance/**/*.js\"",
     "build:apidocs": "lb-apidocs",
     "build": "lb-tsc es2017 --outDir dist",
-    "build:watch": "lb-tsc es2017 --outDir dist --watch",
+    "build:resources": "lb-copy-resources",
+    "build:watch": "lb-tsc --watch",
     "clean": "lb-clean *example-hello-world*.tgz dist package api-docs",
     "verify": "npm pack && tar xf *example-hello-world*.tgz && tree package && npm run clean",
     "lint": "npm run prettier:check && npm run eslint",

examples/context/tsconfig.json

@@ -0,0 +1,27 @@
+{
+  "$schema": "http://json.schemastore.org/tsconfig",
+  "extends": "@loopback/build/config/tsconfig.common.json",
+  "compilerOptions": {
+    "target": "es2017",
+    "outDir": "dist",
+    "rootDir": "src",
+    "composite": true,
+    "incremental": true,
+    "tsBuildInfoFile": ".tsbuildinfo"
+  },
+  "references": [
+    {
+      "path": "../../packages/testlab/tsconfig.json"
+    },
+    {
+      "path": "../../packages/core/tsconfig.json"
+    },
+    {
+      "path": "../../packages/rest/tsconfig.json"
+    }
+  ],
+  "include": [
+    "src/**/*",
+    "src/**/*.json"
+  ]
+}

examples/express-composition/tsconfig.build.json

@@ -8,10 +8,12 @@
     "node": ">=8.9"
   },
   "author": "IBM Corp.",
+  "types": "./dist/index.d.ts",
   "scripts": {
     "build:apidocs": "lb-apidocs",
     "build": "lb-tsc es2017 --outDir dist",
-    "build:watch": "lb-tsc es2017 --outDir dist --watch",
+    "build:resources": "lb-copy-resources",
+    "build:watch": "lb-tsc --watch",
     "clean": "lb-clean *example-log-extension-*.tgz dist package api-docs",
     "lint": "npm run prettier:check && npm run eslint",
     "lint:fix": "npm run eslint:fix && npm run prettier:fix",