refactor: let TypeScript do resource copying

docs/site/Repositories.md

@@ -326,7 +326,7 @@ context.
 ```ts
 import {inject} from '@loopback/core';
 import {juggler, AnyObject} from '@loopback/repository';
-const config = require('./redis.datasource.json');
+import * as config from './redis.datasource.json';
 
 export class RedisDataSource extends juggler.DataSource {
   static dataSourceName = 'redis';

docs/site/Testing-your-application.md

@@ -652,8 +652,7 @@ instance:
 
 ```ts
 import {merge} from 'lodash';
-
-const GEO_CODER_CONFIG = require('../src/datasources/geo.datasource.json');
+import * as GEO_CODER_CONFIG from '../src/datasources/geo.datasource.json';
 
 function givenGeoService() {
   const config = merge({}, GEO_CODER_CONFIG, {

examples/soap-calculator/src/datasources/calculator.datasource.ts

@@ -1,13 +1,13 @@
 import {inject} from '@loopback/core';
-import {juggler, AnyObject} from '@loopback/repository';
-const config = require('./calculator.datasource.json');
+import {juggler} from '@loopback/repository';
+import * as config from './calculator.datasource.json';
 
 export class CalculatorDataSource extends juggler.DataSource {
   static dataSourceName = 'calculator';
 
   constructor(
     @inject('datasources.config.calculator', {optional: true})
-    dsConfig: AnyObject = config,
+    dsConfig: object = config,
   ) {
     dsConfig = Object.assign({}, dsConfig, {
       // A workaround for the current design flaw where inside our monorepo,

examples/todo-list/src/datasources/db.datasource.ts

@@ -4,15 +4,15 @@
 // License text available at https://opensource.org/licenses/MIT
 
 import {inject} from '@loopback/core';
-import {juggler, DataSource} from '@loopback/repository';
-const config = require('./db.datasource.json');
+import {juggler} from '@loopback/repository';
+import * as config from './db.datasource.json';
 
 export class DbDataSource extends juggler.DataSource {
   static dataSourceName = 'db';
 
   constructor(
     @inject('datasources.config.db', {optional: true})
-    dsConfig: DataSource = config,
+    dsConfig: object = config,
   ) {
     super(dsConfig);
   }

examples/todo/src/datasources/db.datasource.ts

@@ -4,15 +4,15 @@
 // License text available at https://opensource.org/licenses/MIT
 
 import {inject} from '@loopback/core';
-import {juggler, DataSource} from '@loopback/repository';
-const config = require('./db.datasource.json');
+import {juggler} from '@loopback/repository';
+import * as config from './db.datasource.json';
 
 export class DbDataSource extends juggler.DataSource {
   static dataSourceName = 'db';
 
   constructor(
     @inject('datasources.config.db', {optional: true})
-    dsConfig: DataSource = config,
+    dsConfig: object = config,
   ) {
     super(dsConfig);
   }

examples/todo/src/datasources/geocoder.datasource.ts

@@ -5,7 +5,7 @@
 
 import {inject} from '@loopback/core';
 import {juggler, AnyObject} from '@loopback/repository';
-const config = require('./geocoder.datasource.json');
+import * as config from './geocoder.datasource.json';
 
 export class GeocoderDataSource extends juggler.DataSource {
   static dataSourceName = 'geocoder';

examples/todo/test/helpers.ts

@@ -8,6 +8,7 @@ import {merge} from 'lodash';
 import * as path from 'path';
 import {Todo} from '../src/models/index';
 import {GeoPoint} from '../src/services/geocoder.service';
+import * as GEO_CODER_CONFIG from '../src/datasources/geocoder.datasource.json';
 
 /*
  ==============================================================================
@@ -54,8 +55,6 @@ export const aLocation = {
   },
 };
 
-const GEO_CODER_CONFIG = require('../src/datasources/geocoder.datasource.json');
-
 export function getProxiedGeoCoderConfig(proxy: HttpCachingProxy) {
   return merge({}, GEO_CODER_CONFIG, {
     options: {

packages/build/README.md

@@ -92,9 +92,9 @@ Now you run the scripts, such as:
 
   - The following un-official compiler options are available:
 
-    | Option               | Description                         |
-    | -------------------- | ----------------------------------- |
-    | `--ignore-resources` | Do not copy any resources to outDir |
+    | Option             | Description                                                                                       |
+    | ------------------ | ------------------------------------------------------------------------------------------------- |
+    | `--copy-resources` | Copy all non-typescript files from `src` and `test` to `outDir`, preserving their relative paths. |
 
 - lb-tslint
 

packages/build/bin/compile-package.js

@@ -31,17 +31,17 @@ function run(argv, options) {
   const isTargetSet = utils.isOptionSet(compilerOpts, '--target');
   const isOutDirSet = utils.isOptionSet(compilerOpts, '--outDir');
   const isProjectSet = utils.isOptionSet(compilerOpts, '-p', '--project');
-  const isIgnoreResourcesSet = utils.isOptionSet(
+  const isCopyResourcesSet = utils.isOptionSet(
     compilerOpts,
-    '--ignore-resources',
+    '--copy-resources',
   );
 
   var target;
 
-  // --ignore-resources is not a TS Compiler option so we remove it from the
+  // --copy-resources is not a TS Compiler option so we remove it from the
   // list of compiler options to avoid compiler errors.
-  if (isIgnoreResourcesSet) {
-    compilerOpts.splice(compilerOpts.indexOf('--ignore-resources'), 1);
+  if (isCopyResourcesSet) {
+    compilerOpts.splice(compilerOpts.indexOf('--copy-resources'), 1);
   }
 
   if (!isTargetSet) {
@@ -128,9 +128,9 @@ function run(argv, options) {
     args.push('--outDir', path.relative(cwd, outDir));
 
     // Since outDir is set, ts files are compiled into that directory.
-    // If ignore-resources flag is not passed, copy resources (non-ts files)
+    // If copy-resources flag is passed, copy resources (non-ts files)
     // to the same outDir as well.
-    if (rootDir && tsConfigFile && !isIgnoreResourcesSet) {
+    if (rootDir && tsConfigFile && isCopyResourcesSet) {
       const tsConfig = require(tsConfigFile);
       const dirs = tsConfig.include
         ? tsConfig.include.join('|')

packages/build/config/tsconfig.common.json

@@ -5,6 +5,7 @@
     "experimentalDecorators": true,
     "noImplicitAny": true,
     "strictNullChecks": true,
+    "resolveJsonModule": true,
 
     "lib": ["es2018", "dom", "esnext.asynciterable"],
     "module": "commonjs",

packages/cli/generators/datasource/templates/datasource.ts.ejs

@@ -1,13 +1,13 @@
 import {inject} from '@loopback/core';
-import {juggler, AnyObject} from '@loopback/repository';
-const config = require('./<%= jsonFileName %>');
+import {juggler} from '@loopback/repository';
+import * as config from './<%= jsonFileName %>';
 
 export class <%= className %>DataSource extends juggler.DataSource {
   static dataSourceName = '<%= name %>';
 
   constructor(
     @inject('datasources.config.<%= name %>', {optional: true})
-    dsConfig: AnyObject = config,
+    dsConfig: object = config,
   ) {
     super(dsConfig);
   }

packages/cli/test/integration/generators/datasource.integration.js

@@ -163,11 +163,11 @@ function checkBasicDataSourceFiles() {
   assert.fileContent(expectedTSFile, /import {inject} from '@loopback\/core';/);
   assert.fileContent(
     expectedTSFile,
-    /import {juggler, AnyObject} from '@loopback\/repository';/,
+    /import {juggler} from '@loopback\/repository';/,
   );
   assert.fileContent(
     expectedTSFile,
-    /const config = require\('.\/ds.datasource.json'\)/,
+    /import \* as config from '.\/ds.datasource.json';/,
   );
   assert.fileContent(
     expectedTSFile,

packages/http-server/test/integration/http-server.integration.ts

@@ -211,13 +211,14 @@ describe('HttpServer (integration)', () => {
     host?: string;
   }): HttpServer {
     const options: HttpServerOptions = {protocol: 'https', host};
+    const certDir = path.resolve(__dirname, '../../../fixtures');
     if (usePfx) {
-      const pfxPath = path.join(__dirname, 'pfx.pfx');
+      const pfxPath = path.join(certDir, 'pfx.pfx');
       options.pfx = fs.readFileSync(pfxPath);
       options.passphrase = 'loopback4';
     } else {
-      const keyPath = path.join(__dirname, 'key.pem');
-      const certPath = path.join(__dirname, 'cert.pem');
+      const keyPath = path.join(certDir, 'key.pem');
+      const certPath = path.join(certDir, 'cert.pem');
       options.key = fs.readFileSync(keyPath);
       options.cert = fs.readFileSync(certPath);
     }

packages/rest/test/integration/rest.server.integration.ts

@@ -19,6 +19,8 @@ import * as path from 'path';
 import * as fs from 'fs';
 import {RestServerConfig} from '../..';
 
+const FIXTURES = path.resolve(__dirname, '../../../fixtures');
+
 describe('RestServer (integration)', () => {
   it('exports url property', async () => {
     // Explicitly setting host to IPv4 address so test runs on Travis
@@ -79,7 +81,7 @@ describe('RestServer (integration)', () => {
   });
 
   it('does not allow static assets to be mounted at /', async () => {
-    const root = path.join(__dirname, 'fixtures');
+    const root = FIXTURES;
     const server = await givenAServer({
       rest: {
         port: 0,
@@ -112,7 +114,7 @@ describe('RestServer (integration)', () => {
   });
 
   it('allows static assets via api', async () => {
-    const root = path.join(__dirname, 'fixtures');
+    const root = FIXTURES;
     const server = await givenAServer({
       rest: {
         port: 0,
@@ -130,7 +132,7 @@ describe('RestServer (integration)', () => {
   });
 
   it('allows static assets via api after start', async () => {
-    const root = path.join(__dirname, 'fixtures');
+    const root = FIXTURES;
     const server = await givenAServer({
       rest: {
         port: 0,
@@ -148,7 +150,7 @@ describe('RestServer (integration)', () => {
   });
 
   it('allows non-static routes after assets', async () => {
-    const root = path.join(__dirname, 'fixtures');
+    const root = FIXTURES;
     const server = await givenAServer({
       rest: {
         port: 0,
@@ -163,7 +165,7 @@ describe('RestServer (integration)', () => {
   });
 
   it('serve static assets if matches before other routes', async () => {
-    const root = path.join(__dirname, 'fixtures');
+    const root = FIXTURES;
     const server = await givenAServer({
       rest: {
         port: 0,
@@ -492,8 +494,8 @@ paths:
   });
 
   it('supports HTTPS protocol with key and certificate files', async () => {
-    const keyPath = path.join(__dirname, 'key.pem');
-    const certPath = path.join(__dirname, 'cert.pem');
+    const keyPath = path.join(FIXTURES, 'key.pem');
+    const certPath = path.join(FIXTURES, 'cert.pem');
     const options = {
       port: 0,
       protocol: 'https',
@@ -510,7 +512,7 @@ paths:
   });
 
   it('supports HTTPS protocol with a pfx file', async () => {
-    const pfxPath = path.join(__dirname, 'pfx.pfx');
+    const pfxPath = path.join(FIXTURES, 'pfx.pfx');
     const options = {
       port: 0,
       protocol: 'https',
@@ -528,8 +530,8 @@ paths:
   });
 
   itSkippedOnTravis('handles IPv6 loopback address in HTTPS', async () => {
-    const keyPath = path.join(__dirname, 'key.pem');
-    const certPath = path.join(__dirname, 'cert.pem');
+    const keyPath = path.join(FIXTURES, 'key.pem');
+    const certPath = path.join(FIXTURES, 'cert.pem');
     const server = await givenAServer({
       rest: {
         port: 0,
@@ -549,8 +551,8 @@ paths:
 
   // https://github.com/strongloop/loopback-next/issues/1623
   itSkippedOnTravis('handles IPv6 address for API Explorer UI', async () => {
-    const keyPath = path.join(__dirname, 'key.pem');
-    const certPath = path.join(__dirname, 'cert.pem');
+    const keyPath = path.join(FIXTURES, 'key.pem');
+    const certPath = path.join(FIXTURES, 'cert.pem');
     const server = await givenAServer({
       rest: {
         port: 0,
@@ -576,8 +578,8 @@ paths:
   });
 
   it('honors HTTPS config binding after instantiation', async () => {
-    const keyPath = path.join(__dirname, 'key.pem');
-    const certPath = path.join(__dirname, 'cert.pem');
+    const keyPath = path.join(FIXTURES, 'key.pem');
+    const certPath = path.join(FIXTURES, 'cert.pem');
     const options = {
       port: 0,
       protocol: 'https',

packages/testlab/test/integration/test-sandbox.integration.ts

@@ -7,11 +7,13 @@ import {TestSandbox, expect} from '../..';
 import {resolve} from 'path';
 import {remove, pathExists, readFile, writeJSON} from 'fs-extra';
 
+const FIXTURES = resolve(__dirname, '../../../fixtures');
+
 describe('TestSandbox integration tests', () => {
   let sandbox: TestSandbox;
   let path: string;
   const COPY_FILE = 'copy-me.txt';
-  const COPY_FILE_PATH = resolve(__dirname, '../fixtures', COPY_FILE);
+  const COPY_FILE_PATH = resolve(FIXTURES, COPY_FILE);
 
   beforeEach(createSandbox);
   beforeEach(givenPath);

tslint.build.json

@@ -4,7 +4,8 @@
   "linterOptions": {
     "exclude": [
       "./packages/cli/generators/*/templates/**/*",
-      "./packages/cli/test/sandbox/**/*"
+      "./packages/cli/test/sandbox/**/*",
+      "**/*.json"
     ]
   }
 }

tslint.json

@@ -4,7 +4,8 @@
   "linterOptions": {
     "exclude": [
       "./packages/cli/generators/*/templates/**/*",
-      "./packages/cli/test/sandbox/**/*"
+      "./packages/cli/test/sandbox/**/*",
+      "**/*.json"
     ]
   }
 }