js-build-tools 2.2.2 → 2.2.4

package/README.md

@@ -1,29 +1,38 @@
 # js-build-tools
-Centralize the build process for node.js and JS projects into a single tool suite.
+
+Centralize the build process for Node.js, JS and TypeScript projects into a single tool suite.
 
 ### Goals
+
 Using this tool suite, you can:
+
+* Parse TypeScript into JS distribution files
 * Create formatted distribution files to be used in a node / commonjs environment.
 * Bundle your distribution files to be used in a browser environment.
 * Run tests and watch for changes.
 * Generate jsdoc readme files.
 
 ## Installation
+
 In your project's root directory, run: `npm install --save-dev gulp js-build-tools`
 (or `yarn add --dev gulp js-build-tools` if you use Yarn).
 
-It is recommended to install gulp with the `-g` flag, so that you can run it with `gulp` instead of `node_modules/.bin/gulp`.
+It is recommended to install gulp with the `-g` flag, so that you can run it with `gulp` instead
+of `node_modules/.bin/gulp`.
 
 ## Configuration
-In your project's root directory, create a `build-tools.config.js` file. This can contain any of the following (values provided are the defaults):
-```
+
+In your project's root directory, create a `build-tools.config.js` file. This can contain any of the following (values
+provided are the defaults):
+
+```js
 module.exports = {
   // The name to use for the browser-bundled output file (.js will be appended).
   browserName: 'my-package',
 
   // The output directory for browser-bundled files.
   browserPath: 'browser',
-  
+
   // The paths for directories to delete before build.
   cleanPaths: ['dist', 'browser'],
 
@@ -34,55 +43,71 @@ module.exports = {
   distPath: 'dist',
 
   // The search pattern used for retrieving compiled distribution files.
-  distSearch: 'dist/**/*.js',]\
-  
+  distSearch: 'dist/**/*.js',
+
   // 'true' to only generate node environment files.
   nodeOnly: false,
-  
+
   // The name of the output documentation markdown file.
   readmeFile: 'README.md',
-  
+
   // The directory to output the readme file in.
   readmePath: './',
-  
+
   // Options for formatting the output readme.
   readmeOptions: 'utf8',
 
   // The file which will be pre-fixed to your README.md output.
   readmeTemplate: 'MAIN.md',
-  
+
   // Location of files to use for compiling documentation into the readme.
   readmeSearch: ['gulpfile.base.js', 'gulp.config.js', 'functions/**/!(*.test).js'],
 
   // Base directory of the project.
   rootPath: './',
-  
+
   // The directory where your source files are stored (the files you manually created).
   srcPath: 'src',
 
   // The search pattern used for gathering source files for distribution.
   srcSearch: 'src/**/!(*.test).js',
-  
+
   // Additional flags for programatically running Jest Cli.
   testOptions: null,
 
   // The directory where Jest test files are stored.
   // By default stored as *.test.js adjacent with the files they are testing).
   testPath: 'src',
-  
+
+  // Pattern for finding the TypeScript files
+  tsSearch: 'src/**/*.ts',
+
   // The path the tsconfig file for running typescript or false if no ts file given.
   useTsConfig: 'tsconfig.json',
-  
+
   // The search pattern for watching files for changes.
   watchSearch: 'src/**/*.js',
 }
 ```
 
 ### Create your local gulpfile.js
-In your project's root directory, create a `gulpfile.js` file, in here you can require any of the functions you need. For example:
-```
+
+In your project's root directory, create a `gulpfile.js` file, in here you can require any of the functions you need.
+For example:
+
+```js
 // Your local gulpfile.js
-const { build, defaultCmd, readme, testFull, testQuick, watchFull, watchTest } = require('js-build-tools')
+const {
+  build,
+  defaultCmd,
+  partials,
+  readme,
+  testFull,
+  testQuick,
+  typescript,
+  watchFull,
+  watchTest
+} = require('js-build-tools')
 
 // Everything you export will be created as a gulp task.
 // You can build your own tasks here as well by using some of the functions `js-build-tools/functions`.
@@ -99,19 +124,65 @@ exports.watchTest = watchTest
 Verify your tasks are available by running `gulp --tasks`.
 
 ### Configure Babel
+
 Depending on how you wrote your test files, Jest may require some Babel configuration.
 Create a `babel.config.js` file in the root directory of your project.
-You can then use the recommended configuration by requiring the babel.config.js file into your own configuration file.
+You can then use the recommended configuration by requiring the `babel.config.js` file into your own configuration file.
 Example:
-```
+
+```js
 const babelConfig = require('js-build-tools/babel.config')
 // You may add additional configuration here. Example: babelConfig.presets.push('@babel/preset-env')
 module.exports = babelConfig
 ```
 
-### Configure Scripts
-In your package.json file, add the following scripts:
+### Configure TypeScript (optional)
+
+Create a `tsconfig.json` file in your project root with the following:
+
+```json
+{
+  "files": [
+    "src/**/*.ts"
+  ],
+  "compilerOptions": {
+    "noImplicitAny": true,
+    "target": "es6",
+    "moduleResolution": "node"
+  }
+}
+```
+
+The pattern for `"files"` should match your .ts files, but the essential thing is that it is wrapped in an array.
+The actual pattern used comes from `babel.config.js` as `'tsSearch'` setting.
+
+Add the following to the exports in your `babel.config.js`:
+
+```js
+module.exports = {
+  readmeSearch: 'dist/**/!(*.min).js',
+  useTsConfig: 'tsconfig.json',
+}
+```
+
+The `js-to-markdown` only works on .js files, so we run the readme search on the built dist files. Also, we want to
+register the tsconfig.json we created earlier and will alter the processes to build for TypeScript.
+
+Update `babel.config.js` with the following:
+
+```js
+const babelConfig = require('js-build-tools/babel.config')
+// This is the important line, we need to add compatibility for Jest to run tests on .ts files
+babelConfig.presets.push('@babel/preset-typescript')
+module.exports = babelConfig
 ```
+
+### Configure Scripts
+
+In your `package.json` file, add the following scripts:
+
+```json
+{
   "scripts": {
     "build": "gulp build",
     "dev": "gulp",
@@ -120,12 +191,13 @@ In your package.json file, add the following scripts:
     "test:quick": "gulp testQuick",
     "watch": "gulp watchFull",
     "watch:test": "gulp watchTest"
-  },
+  }
+}
 ```
 
 ## Usage
-Run any of the above commands with `gulp` or `npm run`.
 
+Run any of the above commands with `gulp` or `npm run`.
 
 # Available functions documentation
 
@@ -168,7 +240,7 @@ Export these functions to your own project in order to customize your build pipe
     * [.bundleMinify()](#module_js-build-tools.bundleMinify) ⇒ <code>\*</code>
     * [.bundleLint()](#module_js-build-tools.bundleLint) ⇒ <code>stream.Stream</code>
     * [.bundle()](#module_js-build-tools.bundle) ⇒ <code>stream.Stream</code>
-    * [.build([done])](#module_js-build-tools.build) ⇒ <code>stream.Stream</code>
+    * [.build()](#module_js-build-tools.build) ⇒ <code>stream.Stream</code>
 
 <a name="module_js-build-tools.compileReadme"></a>
 
@@ -255,15 +327,10 @@ Starting at the distribution entry point, bundle all the files into a single fil
 **Kind**: static method of [<code>js-build-tools</code>](#module_js-build-tools)  
 <a name="module_js-build-tools.build"></a>
 
-### js-build-tools.build([done]) ⇒ <code>stream.Stream</code>
+### js-build-tools.build() ⇒ <code>stream.Stream</code>
 Runs several processes to build and validate the project.
 
 **Kind**: static method of [<code>js-build-tools</code>](#module_js-build-tools)  
-
-| Param | Type | Default |
-| --- | --- | --- |
-| [done] | <code>function</code> | <code></code> | 
-
 <a name="module_gulpConfig"></a>
 
 ## gulpConfig

package/dist/build.js

@@ -7,7 +7,6 @@ var _require = require('./partials')
 var clean = _require.clean
 var distSeries = _require.distSeries
 var compileReadme = require('./compileReadme')
-var dist = require('./dist')
 var distLint = require('./distLint')
 var distMinify = require('./distMinify')
 var _require2 = require('gulp')
@@ -20,11 +19,28 @@ var testFull = require('./testFull')
  * Runs several processes to build and validate the project.
  * Cleans, distributes (lint and minify), bundles (lint and minify), creates the readme, then runs the tests.
  * @memberOf module:js-build-tools
- * @param {function} [done=null]
  * @returns {stream.Stream}
  */
 var build = function build () {
   var done = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : null
-  return parallel(gulpConfig.get('nodeOnly') ? series(clean, dist, parallel(distLint, distMinify)) : series(clean, distSeries(), parallel(distLint, distMinify), bundle, parallel(bundleLint, bundleMinify)), compileReadme, testFull)(done)
+  var distLintMinify = parallel(distLint, distMinify)
+  var bundleLintMinify = parallel(bundleLint, bundleMinify)
+  var buildActions = [clean, distSeries(), distLintMinify]
+  if (gulpConfig.get('useTsConfig')) {
+    // For ts usage, we need to run the readme on the dist directly since that is where the .js files are located
+    buildActions.push(compileReadme)
+  }
+  if (!gulpConfig.get('nodeOnly')) {
+    // If not 'nodeOnly' then we also want to bundle for browser after we complete the dist directory
+    buildActions.push(bundle)
+    buildActions.push(bundleLintMinify)
+  }
+  var runActions = [series.apply(void 0, buildActions)]
+  if (!gulpConfig.get('useTsConfig')) {
+    // Since we didn't run this in series after dist because of typescript, we need to run it now. Potentially faster here.
+    runActions.push(compileReadme)
+  }
+  runActions.push(testFull)
+  return parallel.apply(void 0, runActions)(done)
 }
 module.exports = build

package/dist/build.min.js

@@ -1 +1 @@
-"use strict";var bundle=require("./bundle"),bundleLint=require("./bundleLint"),bundleMinify=require("./bundleMinify"),_require=require("./partials"),clean=_require.clean,distSeries=_require.distSeries,compileReadme=require("./compileReadme"),dist=require("./dist"),distLint=require("./distLint"),distMinify=require("./distMinify"),_require2=require("gulp"),parallel=_require2.parallel,series=_require2.series,gulpConfig=require("../gulp.config.js"),testFull=require("./testFull"),build=function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:null;return parallel(gulpConfig.get("nodeOnly")?series(clean,dist,parallel(distLint,distMinify)):series(clean,distSeries(),parallel(distLint,distMinify),bundle,parallel(bundleLint,bundleMinify)),compileReadme,testFull)(e)};module.exports=build;
+"use strict";var bundle=require("./bundle"),bundleLint=require("./bundleLint"),bundleMinify=require("./bundleMinify"),_require=require("./partials"),clean=_require.clean,distSeries=_require.distSeries,compileReadme=require("./compileReadme"),distLint=require("./distLint"),distMinify=require("./distMinify"),_require2=require("gulp"),parallel=_require2.parallel,series=_require2.series,gulpConfig=require("../gulp.config.js"),testFull=require("./testFull"),build=function(){var e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:null,i=parallel(distLint,distMinify),l=parallel(bundleLint,bundleMinify),r=[clean,distSeries(),i];gulpConfig.get("useTsConfig")&&r.push(compileReadme),gulpConfig.get("nodeOnly")||(r.push(bundle),r.push(l));var u=[series.apply(void 0,r)];return gulpConfig.get("useTsConfig")||u.push(compileReadme),u.push(testFull),parallel.apply(void 0,u)(e)};module.exports=build;

package/dist/test-helpers/setUp.js

@@ -42,18 +42,21 @@ var setDefaults = function setDefaults() {
   var testDir = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : 'test-temp';
   tempDir = "".concat(testDir, "/");
   srcPath = "".concat(tempDir, "src");
-  gulpConfig.set('browserPath', "".concat(tempDir, "browser"));
-  gulpConfig.set('cleanPaths', [srcPath]);
-  gulpConfig.set('distMain', "".concat(tempDir, "dist/main"));
-  gulpConfig.set('distPath', "".concat(tempDir, "dist"));
-  gulpConfig.set('distSearch', "".concat(tempDir, "dist/**/*.js"));
+  var distPath = "".concat(tempDir, "dist");
+  var browserPath = "".concat(tempDir, "browser");
+  gulpConfig.set('browserPath', browserPath);
+  gulpConfig.set('cleanPaths', [distPath, browserPath]);
+  gulpConfig.set('distMain', "".concat(distPath, "/main"));
+  gulpConfig.set('distPath', distPath);
+  gulpConfig.set('distSearch', "".concat(distPath, "/**/*.js"));
   gulpConfig.set('readmeTemplate', "".concat(tempDir, "MAIN.md"));
   gulpConfig.set('readmePath', tempDir);
+  gulpConfig.set('readmeSearch', "".concat(srcPath, "/**/!(*.test).js"));
   gulpConfig.set('rootPath', tempDir);
   gulpConfig.set('srcPath', srcPath);
-  gulpConfig.set('srcSearch', "".concat(tempDir, "src/**/!(*.test).js"));
-  gulpConfig.set('tsSearch', "".concat(tempDir, "src/**/*.ts"));
-  gulpConfig.set('watchSearch', "".concat(tempDir, "src/**/*.js"));
+  gulpConfig.set('srcSearch', "".concat(srcPath, "/**/!(*.test).js"));
+  gulpConfig.set('tsSearch', "".concat(srcPath, "/**/*.ts"));
+  gulpConfig.set('watchSearch', "".concat(srcPath, "/**/*.js"));
 };
 exports.setDefaults = setDefaults;
 exports.gulpConfig = gulpConfig;

package/functions/build.js

@@ -3,7 +3,6 @@ const bundleLint = require('./bundleLint')
 const bundleMinify = require('./bundleMinify')
 const { clean, distSeries } = require('./partials')
 const compileReadme = require('./compileReadme')
-const dist = require('./dist')
 const distLint = require('./distLint')
 const distMinify = require('./distMinify')
 const { parallel, series } = require('gulp')
@@ -14,15 +13,32 @@ const testFull = require('./testFull')
  * Runs several processes to build and validate the project.
  * Cleans, distributes (lint and minify), bundles (lint and minify), creates the readme, then runs the tests.
  * @memberOf module:js-build-tools
- * @param {function} [done=null]
  * @returns {stream.Stream}
  */
-const build = (done = null) => parallel(
-  gulpConfig.get('nodeOnly')
-    ? series(clean, dist, parallel(distLint, distMinify))
-    : series(clean, distSeries(), parallel(distLint, distMinify), bundle, parallel(bundleLint, bundleMinify)),
-  compileReadme,
-  testFull
-)(done)
+const build = (done = null) => {
+  const distLintMinify = parallel(distLint, distMinify)
+  const bundleLintMinify = parallel(bundleLint, bundleMinify)
+  const buildActions = [clean, distSeries(), distLintMinify]
+  if (gulpConfig.get('useTsConfig')) {
+    // For ts usage, we need to run the readme on the dist directly since that is where the .js files are located
+    buildActions.push(compileReadme)
+  }
+  if (!gulpConfig.get('nodeOnly')) {
+    // If not 'nodeOnly' then we also want to bundle for browser after we complete the dist directory
+    buildActions.push(bundle)
+    buildActions.push(bundleLintMinify)
+  }
+  const runActions = [
+    series(...buildActions),
+  ]
+  if (!gulpConfig.get('useTsConfig')) {
+    // Since we didn't run this in series after dist because of typescript, we need to run it now. Potentially faster here.
+    runActions.push(compileReadme)
+  }
+  runActions.push(testFull)
+  return parallel(
+    ...runActions
+  )(done)
+}
 
 module.exports = build

package/functions/build.test.js

@@ -1,59 +1,303 @@
-const { setUp } = require('./testHelpers')
+const fs = require('fs')
+const setUp = require('./test-helpers/setUp')
+setUp.setDefaults('test-build')
 const gulpConfig = setUp.gulpConfig
 const build = require('./build')
-const bundle = require('./bundle')
-const bundleLint = require('./bundleLint')
-const bundleMinify = require('./bundleMinify')
-const { clean, distSeries } = require('./partials')
-const compileReadme = require('./compileReadme')
-const dist = require('./dist')
-const distLint = require('./distLint')
-const distMinify = require('./distMinify')
+const clean = require('./partials/clean')
 const testFull = require('./testFull')
+const { countMatches } = require('./testHelpers')
 
 const genericFunction = () => Promise.resolve(true)
-jest.mock('./bundle', () => jest.fn(genericFunction))
-jest.mock('./bundleLint', () => jest.fn(genericFunction))
-jest.mock('./bundleMinify', () => jest.fn(genericFunction))
+
 jest.mock('./partials/clean', () => jest.fn(genericFunction))
-jest.mock('./compileReadme', () => jest.fn(genericFunction))
-jest.mock('./dist', () => jest.fn(genericFunction))
-jest.mock('./distLint', () => jest.fn(genericFunction))
-jest.mock('./distMinify', () => jest.fn(genericFunction))
-jest.mock('./partials/distSeries', () => jest.fn(() => genericFunction))
 jest.mock('./testFull', () => jest.fn(genericFunction))
 
+const file1Typescript = '/**\n' +
+  ' * Console log out a greeting with given input.\n' +
+  ' * @param {string} input\n' +
+  ' */\n' +
+  'const file1 = (input: string): void => console.log(`Hello from file1 with ${input}`)\n' +
+  '\n' +
+  'module.exports = file1\n'
+
+const file1Contents = '/**\n' +
+  ' * Console log out a greeting with given input.\n' +
+  ' * @param {string} input\n' +
+  ' */\n' +
+  'const file1 = input => console.log(`Hello from file1 with ${input}`)\n' +
+  '\n' +
+  'module.exports = file1\n'
+
+const file2Typescript = '/**\n' +
+  ' * Farewell with a summation of two numbers returned.\n' +
+  ' * @param {number} a\n' +
+  ' * @param {number} b\n' +
+  ' * @returns {number}\n' +
+  ' */\n' +
+  'const file2 = (a: number, b: number): number => {\n' +
+  '  const sum = a + b\n' +
+  '  console.log(`Good-bye from file2 with sum ${sum}`)\n' +
+  '  return sum\n' +
+  '}\n' +
+  '\n' +
+  'module.exports = file2\n'
+
+const file2Contents = '/**\n' +
+  ' * Farewell with a summation of two numbers returned.\n' +
+  ' * @param {number} a\n' +
+  ' * @param {number} b\n' +
+  ' * @returns {number}\n' +
+  ' */\n' +
+  'const file2 = (a, b) => {\n' +
+  '  const sum = a + b\n' +
+  '  console.log(`Good-bye from file2 with sum ${sum}`)\n' +
+  '  return sum\n' +
+  '}\n' +
+  '\n' +
+  'module.exports = file2\n'
+
+const mainTypescript = '/**\n' +
+  ' * A salutation and summation.\n' +
+  ' * @param {number} a\n' +
+  ' * @param {number} b\n' +
+  ' * @returns {number}\n' +
+  ' */\n' +
+  'const main = (a: number, b: number): number => {\n' +
+  '  const sum = a + b\n' +
+  '  console.log(`Greetings from typescript ${sum}`)\n' +
+  '  return sum\n' +
+  '}\n' +
+  '\n' +
+  'module.exports = main\n'
+
+const mainFileContents = '/**\n' +
+  ' * Some test functions for usage with build tests.\n' +
+  ' * @file\n' +
+  ' * @author John Doe <john.doe@example.com>\n' +
+  ' * @version 1.0.0\n' +
+  ' * @module test-build\n' +
+  ' */\n' +
+  '\n' +
+  'const file1 = require(\'./sources/file1\')\n' +
+  'const file2 = require(\'./sources/file2\')\n' +
+  '\n' +
+  'module.exports = {\n' +
+  '  file1,\n' +
+  '  file2,\n' +
+  '}\n'
+
+const mainMd = '# Welcome\n' +
+  'This is the top of the README.md.\n' +
+  '\n'
+
+const tsConfigContents = '{\n' +
+  '  "files": ["test-build/src/**/*.ts"],\n' +
+  '  "compilerOptions": {\n' +
+  '    "noImplicitAny": true,\n' +
+  '    "target": "es5"\n' +
+  '  }\n' +
+  '}'
+
+beforeEach(
+  () => setUp.beforeEach()
+    .then(
+      async () => {
+        const srcPath = gulpConfig.get('srcPath')
+        const readmePath = gulpConfig.get('readmePath')
+        const sourcesPath = `${srcPath}/sources`
+        await fs.mkdirSync(sourcesPath)
+        return fs.writeFileSync(`${readmePath}/MAIN.md`, mainMd)
+      }
+    )
+)
+
+afterEach(setUp.afterEach)
+
 describe('build', () => {
-  test('when nodeOnly true: calls clean, dist, distLint, distMinify, compileReadme, testFull', done => {
+  test('when nodeOnly true: calls clean, distSeries, distLint, distMinify, compileReadme, testFull', done => {
+    const srcPath = gulpConfig.get('srcPath')
+    const sourcesPath = `${srcPath}/sources`
+    const distPath = gulpConfig.get('distPath')
+    const distSourcesPath = `${distPath}/sources`
+    const readmePath = gulpConfig.get('readmePath')
+    const readmeFile = gulpConfig.get('readmeFile')
+    fs.writeFileSync(`${sourcesPath}/file1.js`, file1Contents)
+    fs.writeFileSync(`${sourcesPath}/file2.js`, file2Contents)
+    fs.writeFileSync(`${srcPath}/main.js`, mainFileContents)
     gulpConfig.set('nodeOnly', true)
-    expect.assertions(6)
-    build()
-    setTimeout(() => {
+    expect.assertions(20)
+    build(() => {
+      // Called 'clean'
       expect(clean).toHaveBeenCalled()
-      expect(dist).toHaveBeenCalled()
-      expect(distLint).toHaveBeenCalled()
-      expect(distMinify).toHaveBeenCalled()
-      expect(compileReadme).toHaveBeenCalled()
+
+      // Created dist directory (distSeries)
+      expect(fs.existsSync(distPath)).toBeTruthy()
+
+      // Minify the dist files (distMinify)
+      expect(fs.existsSync(`${distPath}/main.min.js`)).toBeTruthy()
+      const babelifiedMain = fs.readFileSync(`${distPath}/main.js`).toString()
+      // Used single quotes because of distLint
+      expect(countMatches(babelifiedMain, '\'use strict\'')).toEqual(1)
+
+      expect(fs.existsSync(`${distSourcesPath}/file1.min.js`)).toBeTruthy()
+      const babelifiedFile1 = fs.readFileSync(`${distSourcesPath}/file1.js`).toString()
+      expect(countMatches(babelifiedFile1, '\'use strict\'')).toEqual(1)
+      expect(countMatches(babelifiedFile1, 'const ')).toEqual(0)
+      expect(countMatches(babelifiedFile1, 'var ')).toEqual(1)
+      expect(countMatches(babelifiedFile1, 'function ')).toEqual(1)
+      expect(countMatches(babelifiedFile1, 'return ')).toEqual(1)
+
+      expect(fs.existsSync(`${distSourcesPath}/file2.min.js`)).toBeTruthy()
+      const babelifiedFile2 = fs.readFileSync(`${distSourcesPath}/file2.js`).toString()
+      expect(countMatches(babelifiedFile2, '\'use strict\'')).toEqual(1)
+      expect(countMatches(babelifiedFile2, 'const ')).toEqual(0)
+      expect(countMatches(babelifiedFile2, 'var ')).toEqual(2)
+      expect(countMatches(babelifiedFile2, 'function ')).toEqual(1)
+
+      // Generated README.md (compileReadme)
+      const readmeContents = fs.readFileSync(`${readmePath}/${readmeFile}`).toString()
+      expect(countMatches(readmeContents, mainMd)).toEqual(1)
+      expect(countMatches(readmeContents, 'test-build')).toEqual(4)
+      expect(countMatches(readmeContents, 'file1')).toEqual(4)
+      expect(countMatches(readmeContents, 'file2')).toEqual(4)
+
+      // Ran 'testFull'
       expect(testFull).toHaveBeenCalled()
       done()
-    }, 500)
-  })
+    })
+  }, 30000)
 
   test('when nodeOnly false: calls clean, distSeries, distLint, distMinify, bundle, bundleLint, bundleMinify, compileReadme, testFull', done => {
+    const srcPath = gulpConfig.get('srcPath')
+    const sourcesPath = `${srcPath}/sources`
+    const distPath = gulpConfig.get('distPath')
+    const browserFile = gulpConfig.get('browserName')
+    const browserPath = gulpConfig.get('browserPath')
+    const bundledFile = `${browserPath}/${browserFile}.js`
+    const readmePath = gulpConfig.get('readmePath')
+    const readmeFile = gulpConfig.get('readmeFile')
+    fs.writeFileSync(`${sourcesPath}/file1.js`, file1Contents)
+    fs.writeFileSync(`${sourcesPath}/file2.js`, file2Contents)
+    fs.writeFileSync(`${srcPath}/main.js`, mainFileContents)
     gulpConfig.set('nodeOnly', false)
-    expect.assertions(9)
-    build()
-    setTimeout(() => {
+    expect.assertions(13)
+    build(() => {
+      // Called 'clean'
       expect(clean).toHaveBeenCalled()
-      expect(distSeries).toHaveBeenCalled()
-      expect(distLint).toHaveBeenCalled()
-      expect(distMinify).toHaveBeenCalled()
-      expect(bundle).toHaveBeenCalled()
-      expect(bundleLint).toHaveBeenCalled()
-      expect(bundleMinify).toHaveBeenCalled()
-      expect(compileReadme).toHaveBeenCalled()
+
+      // Created dist directory (distSeries)
+      expect(fs.existsSync(distPath)).toBeTruthy()
+
+      // Minify the dist files (distMinify)
+      expect(fs.existsSync(`${distPath}/main.min.js`)).toBeTruthy()
+      const babelifiedMain = fs.readFileSync(`${distPath}/main.js`).toString()
+      // Used single quotes because of distLint
+      expect(countMatches(babelifiedMain, '\'use strict\'')).toEqual(1)
+
+      // Created browser directory (bundle)
+      expect(fs.existsSync(browserPath)).toBeTruthy()
+
+      // Minify the browser files (bundleMinify)
+      expect(fs.existsSync(`${browserPath}/${browserFile}.min.js`)).toBeTruthy()
+      const bundledContents = fs.readFileSync(bundledFile).toString()
+      expect(countMatches(bundledContents, 'file1')).toEqual(9)
+      expect(countMatches(bundledContents, 'file2')).toEqual(9)
+
+      // Generated README.md (compileReadme)
+      const readmeContents = fs.readFileSync(`${readmePath}/${readmeFile}`).toString()
+      expect(countMatches(readmeContents, mainMd)).toEqual(1)
+      expect(countMatches(readmeContents, 'test-build')).toEqual(4)
+      expect(countMatches(readmeContents, 'file1')).toEqual(4)
+      expect(countMatches(readmeContents, 'file2')).toEqual(4)
+
+      // Ran 'testFull'
+      expect(testFull).toHaveBeenCalled()
+      done()
+    })
+  }, 30000)
+
+  test('when nodeOnly true and useTsConfig set: calls clean, tsFor, distFor, distLint, distMinify, compileReadme, testFull', done => {
+    const srcPath = gulpConfig.get('srcPath')
+    const rootPath = gulpConfig.get('rootPath')
+    const tsConfig = `${rootPath}/tsconfig.json`
+    const distPath = gulpConfig.get('distPath')
+    const readmePath = gulpConfig.get('readmePath')
+    const readmeFile = gulpConfig.get('readmeFile')
+    fs.writeFileSync(`${srcPath}/main.ts`, mainTypescript)
+    fs.writeFileSync(tsConfig, tsConfigContents)
+    gulpConfig.set('nodeOnly', true)
+    gulpConfig.set('useTsConfig', tsConfig)
+    gulpConfig.set('readmeSearch', `${distPath}/**/*.js`)
+    expect.assertions(7)
+    build(() => {
+      // Called 'clean'
+      expect(clean).toHaveBeenCalled()
+
+      // Created dist directory (distSeries)
+      expect(fs.existsSync(distPath)).toBeTruthy()
+
+      // Minify the dist files (distMinify)
+      expect(fs.existsSync(`${distPath}/main.min.js`)).toBeTruthy()
+      const babelifiedMain = fs.readFileSync(`${distPath}/main.js`).toString()
+      // Used single quotes because of distLint
+      expect(countMatches(babelifiedMain, '\'use strict\'')).toEqual(1)
+
+      // Generated README.md (compileReadme)
+      const readmeContents = fs.readFileSync(`${readmePath}/${readmeFile}`).toString()
+      expect(countMatches(readmeContents, mainMd)).toEqual(1)
+      expect(countMatches(readmeContents, 'main')).toEqual(2)
+
+      // Ran 'testFull'
+      expect(testFull).toHaveBeenCalled()
+      done()
+    })
+  }, 30000)
+
+  test('when nodeOnly false and useTsConfig false: calls clean, tsFor, distFor, distLint, distMinify, bundle, bundleLint, bundleMinify, compileReadme, testFull', done => {
+    const srcPath = gulpConfig.get('srcPath')
+    const rootPath = gulpConfig.get('rootPath')
+    const tsConfig = `${rootPath}/tsconfig.json`
+    const distPath = gulpConfig.get('distPath')
+    const browserFile = gulpConfig.get('browserName')
+    const browserPath = gulpConfig.get('browserPath')
+    const bundledFile = `${browserPath}/${browserFile}.js`
+    const readmePath = gulpConfig.get('readmePath')
+    const readmeFile = gulpConfig.get('readmeFile')
+    fs.writeFileSync(`${srcPath}/main.ts`, mainTypescript)
+    fs.writeFileSync(tsConfig, tsConfigContents)
+    gulpConfig.set('nodeOnly', false)
+    gulpConfig.set('useTsConfig', tsConfig)
+    gulpConfig.set('readmeSearch', `${distPath}/**/*.js`)
+    expect.assertions(10)
+    build(() => {
+      // Called 'clean'
+      expect(clean).toHaveBeenCalled()
+
+      // Created dist directory (distSeries)
+      expect(fs.existsSync(distPath)).toBeTruthy()
+
+      // Minify the dist files (distMinify)
+      expect(fs.existsSync(`${distPath}/main.min.js`)).toBeTruthy()
+      const babelifiedMain = fs.readFileSync(`${distPath}/main.js`).toString()
+      // Used single quotes because of distLint
+      expect(countMatches(babelifiedMain, '\'use strict\'')).toEqual(1)
+
+      // Created browser directory (bundle)
+      expect(fs.existsSync(browserPath)).toBeTruthy()
+
+      // Minify the browser files (bundleMinify)
+      expect(fs.existsSync(`${browserPath}/${browserFile}.min.js`)).toBeTruthy()
+      const bundledContents = fs.readFileSync(bundledFile).toString()
+      expect(countMatches(bundledContents, 'main')).toEqual(3)
+
+      // Generated README.md (compileReadme)
+      const readmeContents = fs.readFileSync(`${readmePath}/${readmeFile}`).toString()
+      expect(countMatches(readmeContents, mainMd)).toEqual(1)
+      expect(countMatches(readmeContents, 'main')).toEqual(2)
+
+      // Ran 'testFull'
       expect(testFull).toHaveBeenCalled()
       done()
-    }, 500)
-  })
+    })
+  }, 30000)
 })

package/functions/partials/addToReadme.test.js

@@ -5,9 +5,14 @@ const gulpConfig = setUp.gulpConfig
 gulpConfig.set('srcSearch', 'test-temp/src/addToReadme.js')
 const addToReadme = require('./addToReadme')
 
-const rawContents = 'export function sayHello(name: string) {\n' +
-  '  return `Hello from ${name}`;\n' +
-  '}'
+const rawContents = '/**\n' +
+  ' * Say hello with a given name.\n' +
+  ' * @param {string} name\n' +
+  ' * @returns {string}\n' +
+  ' */\n' +
+  'const sayHello = name => `Hello from ${name}`\n' +
+  '\n' +
+  'module.exports = sayHello\n'
 
 beforeEach(() => setUp.beforeEach()
   .then(() => fs.writeFileSync(gulpConfig.get('srcPath') + '/addToReadme.js', rawContents)))
@@ -22,6 +27,6 @@ describe('addToReadme', () => {
     await expect(fs.existsSync(readmeFilePath)).toBeTruthy()
     const readme = await fs.readFileSync(readmeFilePath)
     // At least the documentation will have the addToReadme documentation
-    await expect(readme.includes('addToReadme')).toBeTruthy()
+    await expect(readme.includes('sayHello')).toBeTruthy()
   })
 })

package/functions/partials/clean.test.js

@@ -2,6 +2,8 @@ const fs = require('fs')
 const setUp = require('../test-helpers/setUp')
 setUp.setDefaults('test-clean')
 const gulpConfig = setUp.gulpConfig
+const srcPath = gulpConfig.get('srcPath')
+gulpConfig.set('cleanPaths', [srcPath])
 const clean = require('./clean')
 
 beforeEach(setUp.beforeEach)
@@ -11,7 +13,6 @@ afterEach(setUp.afterEach)
 describe('clean', () => {
   test('removes all contents of directories specified', async () => {
     expect.assertions(2)
-    const srcPath = gulpConfig.get('srcPath')
     expect(fs.readdirSync(srcPath)).toBeTruthy()
     // Run the clean script to empty the directories
     await clean()

package/functions/test-helpers/setUp.js

@@ -15,18 +15,21 @@ let srcPath = `${tempDir}src`
 const setDefaults = (testDir = 'test-temp') => {
   tempDir = `${testDir}/`
   srcPath = `${tempDir}src`
-  gulpConfig.set('browserPath', `${tempDir}browser`)
-  gulpConfig.set('cleanPaths', [srcPath])
-  gulpConfig.set('distMain', `${tempDir}dist/main`)
-  gulpConfig.set('distPath', `${tempDir}dist`)
-  gulpConfig.set('distSearch', `${tempDir}dist/**/*.js`)
+  const distPath = `${tempDir}dist`
+  const browserPath = `${tempDir}browser`
+  gulpConfig.set('browserPath', browserPath)
+  gulpConfig.set('cleanPaths', [distPath, browserPath])
+  gulpConfig.set('distMain', `${distPath}/main`)
+  gulpConfig.set('distPath', distPath)
+  gulpConfig.set('distSearch', `${distPath}/**/*.js`)
   gulpConfig.set('readmeTemplate', `${tempDir}MAIN.md`)
   gulpConfig.set('readmePath', tempDir)
+  gulpConfig.set('readmeSearch', `${srcPath}/**/!(*.test).js`)
   gulpConfig.set('rootPath', tempDir)
   gulpConfig.set('srcPath', srcPath)
-  gulpConfig.set('srcSearch', `${tempDir}src/**/!(*.test).js`)
-  gulpConfig.set('tsSearch', `${tempDir}src/**/*.ts`)
-  gulpConfig.set('watchSearch', `${tempDir}src/**/*.js`)
+  gulpConfig.set('srcSearch', `${srcPath}/**/!(*.test).js`)
+  gulpConfig.set('tsSearch', `${srcPath}/**/*.ts`)
+  gulpConfig.set('watchSearch', `${srcPath}/**/*.js`)
 }
 
 exports.setDefaults = setDefaults

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-build-tools",
-  "version": "2.2.2",
+  "version": "2.2.4",
   "description": "Standardised build process with gulp.",
   "main": "gulpfile.base.js",
   "scripts": {