feat(build): add an option to copy non ts files to outDir

Copies non-.ts files (json, images, text, etc.) to the outDir (dist) so file paths can remain relative. Does so for the `include` directories listed in `tsconfig.json`.

Author: virkt25

packages/build/README.md

@@ -51,7 +51,7 @@ Please remember to replace `your-module-name` with the name of your module.
 
 Now you run the scripts, such as:
 
-- `npm run build` - Compile TypeScript files
+- `npm run build` - Compile TypeScript files and copy resources (non `.ts` files) to outDir
 - `npm test` - Run all mocha tests
 - `npm run lint` - Run `tslint` and `prettier` on source files
 
@@ -89,6 +89,11 @@ Now you run the scripts, such as:
     For more information, see
     <https://www.typescriptlang.org/docs/handbook/compiler-options.html>.
 
+  - The following un-official compiler options are available:
+    |Option|Description|
+    |--|--|
+    |`--ignore-resources`|Do not copy any resources to outDir|
+
 - lb-tslint
 
   By default, `lb-tslint` searches your project's root directory for

packages/build/bin/compile-package.js

@@ -21,6 +21,8 @@ function run(argv, options) {
   const utils = require('./utils');
   const path = require('path');
   const fs = require('fs');
+  const glob = require('glob');
+  const fse = require('fs-extra');
 
   const packageDir = utils.getPackageDir();
 
@@ -29,9 +31,19 @@ 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(
+    compilerOpts,
+    '--ignore-resources'
+  );
 
   var target;
 
+  // --ignore-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 (!isTargetSet) {
     // Find the last non-option argument as the `target`
     // For example `-p tsconfig.json es2017` or `es2017 -p tsconfig.json`
@@ -110,6 +122,22 @@ function run(argv, options) {
 
   if (outDir) {
     args.push('--outDir', outDir);
+
+    // Since outDir is set, ts files are compiled into that directory.
+    // If ignore-resources flag is not passed, copy resources (non-ts files)
+    // to the same outDir as well.
+    if (rootDir && tsConfigFile && !isIgnoreResourcesSet) {
+      const tsConfig = require(tsConfigFile);
+      const dirs = tsConfig.include
+        ? tsConfig.include.join('|')
+        : ['src', 'test'].join('|');
+
+      const pattern = `@(${dirs})/**/!(*.ts)`;
+      const files = glob.sync(pattern, {root: packageDir, nodir: true});
+      for (const file of files) {
+        fse.copySync(path.join(packageDir, file), path.join(outDir, file));
+      }
+    }
   }
 
   if (target) {

packages/build/config/tsconfig.build.json

@@ -7,5 +7,5 @@
     "src",
     "test"
   ],
-  "exclude": ["node_modules/**", "packages/*/node_modules/**", "examples/*/node_modules/**", "**/*.d.ts"]
+  "exclude": ["node_modules/**", "**/*.d.ts"]
 }

packages/build/package.json

@@ -18,6 +18,7 @@
     "cross-spawn": "^6.0.5",
     "debug": "^3.1.0",
     "fs-extra": "^5.0.0",
+    "glob": "^7.1.2",
     "mocha": "^5.1.1",
     "nyc": "^11.7.1",
     "prettier": "^1.12.1",

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

@@ -11,11 +11,7 @@ describe('TestSandbox integration tests', () => {
   let sandbox: TestSandbox;
   let path: string;
   const COPY_FILE = 'copy-me.txt';
-  const COPY_FILE_PATH = resolve(
-    __dirname,
-    '../../../test/fixtures',
-    COPY_FILE,
-  );
+  const COPY_FILE_PATH = resolve(__dirname, '../fixtures', COPY_FILE);
 
   beforeEach(createSandbox);
   beforeEach(givenPath);