@loopback/build 6.4.1 → 8.0.0

package/README.md

@@ -94,6 +94,15 @@ Now you run the scripts, such as:
     | ------------------ | ------------------------------------------------------------------------------------------------- |
     | `--copy-resources` | Copy all non-typescript files from `src` and `test` to `outDir`, preserving their relative paths. |
 
+  - Using [`ttypescript`](https://github.com/cevek/ttypescript)
+
+    ### Stability: ⚠️Experimental⚠️
+
+    If you would like to use `ttypescript` and its availalbe plugins, you can
+    substitute `lb-tsc` with `lb-ttsc`, or pass the option
+    `lb-tsc --use-ttypescript`. If `ttypescript` is not installed, the default
+    TypeScript compiler `tsc` will be used instead.
+
 4.  Run builds
 
 ```sh
@@ -156,7 +165,7 @@ configured to log failed requests, it will print a log also for requests where
 the failure was expected and intentional. The solution is to configure your REST
 server to suppress error messages for that specific error code only. Our
 `@loopback/testlab` module is providing a helper
-[`createUnexpectedHttpErrorLogger`](https://github.com/strongloop/loopback-next/tree/master/packages/testlab#createUnexpectedHttpErrorLogger)
+[`createUnexpectedHttpErrorLogger`](https://github.com/loopbackio/loopback-next/tree/master/packages/testlab#createUnexpectedHttpErrorLogger)
 that makes this task super easy.
 
 Alternatively, it's also possible to disable detection of console logs by
@@ -164,8 +173,8 @@ calling `lb-mocha` with `--allow-console-logs` argument.
 
 ## Contributions
 
-- [Guidelines](https://github.com/strongloop/loopback-next/blob/master/docs/CONTRIBUTING.md)
-- [Join the team](https://github.com/strongloop/loopback-next/issues/110)
+- [Guidelines](https://github.com/loopbackio/loopback-next/blob/master/docs/CONTRIBUTING.md)
+- [Join the team](https://github.com/loopbackio/loopback-next/issues/110)
 
 ## Tests
 
@@ -174,7 +183,7 @@ run `npm test` from the root folder.
 ## Contributors
 
 See
-[all contributors](https://github.com/strongloop/loopback-next/graphs/contributors).
+[all contributors](https://github.com/loopbackio/loopback-next/graphs/contributors).
 
 ## License
 

package/bin/compile-package.js

@@ -34,8 +34,12 @@ function run(argv, options) {
 
   const packageDir = utils.getPackageDir();
 
-  const compilerOpts = argv.slice(2);
+  const runnerName = argv[1];
 
+  const compilerOpts = argv.slice(2);
+  const runnerIsLbttsc = runnerName.includes('lb-ttsc');
+  const isUseTtscSet = utils.isOptionSet(compilerOpts, '--use-ttypescript');
+  const useTtsc = runnerIsLbttsc || isUseTtscSet;
   const isTargetSet = utils.isOptionSet(compilerOpts, '--target');
   const isOutDirSet = utils.isOptionSet(compilerOpts, '--outDir');
   const isProjectSet = utils.isOptionSet(compilerOpts, '-p', '--project');
@@ -44,12 +48,35 @@ function run(argv, options) {
     '--copy-resources',
   );
 
-  // --copy-resources is not a TS Compiler option so we remove it from the
-  // list of compiler options to avoid compiler errors.
+  let TSC_CLI = 'typescript/lib/tsc';
+  if (useTtsc) {
+    try {
+      require.resolve('ttypescript');
+      TSC_CLI = 'ttypescript/lib/tsc';
+    } catch (e) {
+      if (isUseTtscSet) {
+        console.error(
+          'Error using the --use-ttypescript option - ttypescript is not installed',
+        );
+      } else {
+        console.error('Error using lb-ttsc - ttypescript is not installed');
+      }
+      process.exit(1);
+    }
+  }
+  debug(`Using ${TSC_CLI} to compile package`);
+
+  // --copy-resources and --use-ttypescript are not a TS Compiler options,
+  // so we remove them from the list of compiler options to avoid compiler
+  // errors.
   if (isCopyResourcesSet) {
     compilerOpts.splice(compilerOpts.indexOf('--copy-resources'), 1);
   }
 
+  if (isUseTtscSet) {
+    compilerOpts.splice(compilerOpts.indexOf('--use-ttypescript'), 1);
+  }
+
   let target;
   if (isTargetSet) {
     const targetIx = compilerOpts.indexOf('--target');
@@ -138,7 +165,7 @@ function run(argv, options) {
 
   const validArgs = validArgsForBuild(args);
 
-  return utils.runCLI('typescript/lib/tsc', validArgs, {cwd, ...options});
+  return utils.runCLI(TSC_CLI, validArgs, {cwd, ...options});
 }
 
 /**

package/config/tsconfig.common.json

@@ -10,6 +10,9 @@
     // FIXME(bajtos) LB4 is not compatible with this setting yet
     "strictPropertyInitialization": false,
 
+    // https://devblogs.microsoft.com/typescript/announcing-typescript-4-4/#use-unknown-catch-variables
+    "useUnknownInCatchVariables": false,
+
     "incremental": true,
 
     "lib": ["es2020"],

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@loopback/build",
   "description": "A set of common scripts and default configurations to build LoopBack 4 or other TypeScript modules",
-  "version": "6.4.1",
+  "version": "8.0.0",
   "license": "MIT",
   "bin": {
     "lb-tsc": "./bin/compile-package.js",
+    "lb-ttsc": "./bin/compile-package.js",
     "lb-eslint": "./bin/run-eslint.js",
     "lb-prettier": "./bin/run-prettier.js",
     "lb-mocha": "./bin/run-mocha.js",
@@ -16,11 +17,11 @@
   "copyright.owner": "IBM Corp.",
   "repository": {
     "type": "git",
-    "url": "https://github.com/strongloop/loopback-next.git",
+    "url": "https://github.com/loopbackio/loopback-next.git",
     "directory": "packages/build"
   },
   "engines": {
-    "node": "^10.16 || 12 || 14 || 16"
+    "node": "12 || 14 || 16 || 17"
   },
   "scripts": {
     "test": "npm run mocha",
@@ -30,21 +31,21 @@
     "access": "public"
   },
   "dependencies": {
-    "@loopback/eslint-config": "^10.2.1",
-    "@types/mocha": "^8.2.2",
+    "@loopback/eslint-config": "^12.0.0",
+    "@types/mocha": "^9.0.0",
     "@types/node": "^10.17.60",
     "cross-spawn": "^7.0.3",
-    "debug": "^4.3.1",
-    "eslint": "^7.28.0",
+    "debug": "^4.3.2",
+    "eslint": "^7.32.0",
     "fs-extra": "^10.0.0",
-    "glob": "^7.1.7",
+    "glob": "^7.2.0",
     "lodash": "^4.17.21",
-    "mocha": "^9.0.0",
+    "mocha": "^9.1.3",
     "nyc": "^15.1.0",
-    "prettier": "^2.3.1",
+    "prettier": "^2.4.1",
     "rimraf": "^3.0.2",
-    "source-map-support": "^0.5.19",
-    "typescript": "~4.3.2"
+    "source-map-support": "^0.5.20",
+    "typescript": "~4.5.2"
   },
-  "gitHead": "2a3b684ec76fa299d80b099abbf101358538cb75"
+  "gitHead": "00a62f630c19341ce399cec3a45563b1ead6e3b8"
 }

package/src/fail-on-console-logs.js

@@ -95,7 +95,7 @@ function stopRecordingAndReportProblems() {
   log(
     '\n=== ATTENTION - INVALID USAGE OF CONSOLE LOGS DETECTED ===',
     '\nLearn more at',
-    'https://github.com/strongloop/loopback-next/blob/master/packages/build/README.md#a-note-on-console-logs-printed-by-tests\n',
+    'https://github.com/loopbackio/loopback-next/blob/master/packages/build/README.md#a-note-on-console-logs-printed-by-tests\n',
   );
 
   for (const p of problems) {

package/test/integration/scripts.integration.js

@@ -7,6 +7,7 @@
 
 const assert = require('assert');
 const path = require('path');
+const spawn = require('cross-spawn');
 const fs = require('fs-extra');
 const utils = require('../../bin/utils');
 
@@ -56,6 +57,30 @@ describe('build', /** @this {Mocha.Suite} */ function () {
     });
   });
 
+  describe('with --use-ttypescript', () => {
+    it('Returns an error if ttypescript is not installed', done => {
+      const childProcess = spawn(
+        process.execPath, // Typically '/usr/local/bin/node'
+        ['../../../bin/compile-package', '--use-ttypescript'],
+        {
+          env: Object.create(process.env),
+        },
+      );
+      let processOutput;
+      childProcess.stderr.on('data', m => {
+        processOutput = m.toString('ascii');
+      });
+      childProcess.on('close', code => {
+        assert.equal(code, 1);
+        assert.equal(
+          processOutput,
+          'Error using the --use-ttypescript option - ttypescript is not installed\n',
+        );
+        done();
+      });
+    });
+  });
+
   it('honors tsconfig.build.json over tsconfig.json', () => {
     fs.writeJSONSync('tsconfig.build.json', {
       extends: '../../../config/tsconfig.common.json',