js-build-tools 1.0.5 → 1.0.6

package/README.md

@@ -1,100 +1,353 @@
-# js-build-tools
-Centralize the build process for node.js and JS projects into a single tool suite.
-
-### Goals
-Using this tool suite, you can:
-* 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`.
-
-## 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):
-```
-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 name of entry the distribution file.
-  distMain: 'dist/main',
-
-  // The output directory for the distribution files.
-  distPath: 'dist',
-
-  // The search pattern used for retrieving compiled distribution files.
-  distSearch: 'dist/**/*.js',
-
-  // The file which will be pre-fixed to your README.md output.
-  readmeTemplate: 'MAIN.md',
-
-  // 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',
-
-  // The directory where Jest test files are stored.
-  // By default stored as *.test.js adjacent with the files they are testing).
-  testPath: 'src',
-  
-  // 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:
-```
-// Your local gulpfile.js
-const { build, defaultCmd, readme, testFull, testQuick, 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`.
-// You can list your available tasks by running `gulp --tasks`.
-exports.build = build
-exports.default = defaultCmd
-exports.readme = readme
-exports.testFull = testFull
-exports.testQuick = testQuick
-exports.watchFull = watchFull
-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.
-Example:
-```
-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:
-```
-  "scripts": {
-    "build": "gulp build",
-    "dev": "gulp",
-    "readme": "gulp readme",
-    "test": "gulp testFull",
-    "test:quick": "gulp testQuick",
-    "watch": "gulp watchFull",
-    "watch:test": "gulp watchTest"
-  },
-```
-
-## Usage
-Run any of the above commands with `gulp` or `npm run`.
+# js-build-tools
+Centralize the build process for node.js and JS projects into a single tool suite.
+
+### Goals
+Using this tool suite, you can:
+* 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`.
+
+## 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):
+```
+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 name of entry the distribution file.
+  distMain: 'dist/main',
+
+  // The output directory for the distribution files.
+  distPath: 'dist',
+
+  // The search pattern used for retrieving compiled distribution files.
+  distSearch: 'dist/**/*.js',
+
+  // The file which will be pre-fixed to your README.md output.
+  readmeTemplate: 'MAIN.md',
+
+  // 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',
+
+  // The directory where Jest test files are stored.
+  // By default stored as *.test.js adjacent with the files they are testing).
+  testPath: 'src',
+  
+  // 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:
+```
+// Your local gulpfile.js
+const { build, defaultCmd, readme, testFull, testQuick, 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`.
+// You can list your available tasks by running `gulp --tasks`.
+exports.build = build
+exports.default = defaultCmd
+exports.readme = readme
+exports.testFull = testFull
+exports.testQuick = testQuick
+exports.watchFull = watchFull
+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.
+Example:
+```
+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:
+```
+  "scripts": {
+    "build": "gulp build",
+    "dev": "gulp",
+    "readme": "gulp readme",
+    "test": "gulp testFull",
+    "test:quick": "gulp testQuick",
+    "watch": "gulp watchFull",
+    "watch:test": "gulp watchTest"
+  },
+```
+
+## Usage
+Run any of the above commands with `gulp` or `npm run`.
+
+
+# Available functions documentation
+
+## Constants
+
+<dl>
+<dt><a href="#build">build</a></dt>
+<dd><p>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.</p>
+</dd>
+<dt><a href="#compileReadme">compileReadme</a></dt>
+<dd><p>Generate the README.md file based off of the template, then append the generated documentation.</p>
+</dd>
+<dt><a href="#defaultCmd">defaultCmd</a></dt>
+<dd><p>Recommended as the default task, runs the simple dist and bundle tasks.</p>
+</dd>
+<dt><a href="#logObject">logObject</a></dt>
+<dd><p>Log out an object in a nicely formatted way.</p>
+</dd>
+<dt><a href="#circularObject">circularObject</a> : <code>Object.&lt;string, (string|Object|Array)&gt;</code></dt>
+<dd><p>Multilayered node tree-like structure with parent references</p>
+</dd>
+<dt><a href="#deepReferenceObject">deepReferenceObject</a> : <code>Object.&lt;string, (string|number|Object)&gt;</code></dt>
+<dd><p>Sample object with deep references.</p>
+</dd>
+<dt><a href="#linkedList">linkedList</a> : <code>Object.&lt;string, (string|Object)&gt;</code></dt>
+<dd><p>Sample LinkedList for testing circular references.</p>
+</dd>
+<dt><a href="#jsonDom">jsonDom</a></dt>
+<dd><p>Sample of jsonDom object containing empty nested array and objects</p>
+</dd>
+<dt><a href="#domItem">domItem</a></dt>
+<dd><p>Sample of domItem child with nested child and optional details</p>
+</dd>
+<dt><a href="#multiReferenceObject">multiReferenceObject</a> : <code>Object.&lt;string, (string|number|Object)&gt;</code></dt>
+<dd><p>Sample of object containing multiple references.</p>
+</dd>
+<dt><a href="#nodeTree">nodeTree</a> : <code>Object.&lt;string, (string|Object|Array)&gt;</code></dt>
+<dd><p>Sample NodeTree for testing circular references and arrays.</p>
+</dd>
+</dl>
+
+## Functions
+
+<dl>
+<dt><a href="#addToReadme">addToReadme()</a> ⇒ <code>string</code> | <code>Uint8Array</code></dt>
+<dd><p>Appends all the jsdoc comments to the readme file. Assumes empty or templated file.</p>
+</dd>
+<dt><a href="#bundle">bundle()</a> ⇒ <code>*</code></dt>
+<dd><p>Starting at the distribution entry point, bundle all the files into a single file and store them in the specified output directory.</p>
+</dd>
+<dt><a href="#bundleLint">bundleLint()</a> ⇒ <code>*</code></dt>
+<dd><p>Applies Standard code style linting to bundled file.</p>
+</dd>
+<dt><a href="#bundleMinify">bundleMinify()</a> ⇒ <code>*</code></dt>
+<dd><p>Creates the minified bundle file.</p>
+</dd>
+<dt><a href="#clean">clean()</a> ⇒ <code>Promise.&lt;Array.&lt;string&gt;&gt;</code> | <code>*</code></dt>
+<dd><p>Deletes all the distribution and browser files (used before create a new build).</p>
+</dd>
+<dt><a href="#dist">dist()</a> ⇒ <code>*</code></dt>
+<dd><p>Simplified distribution tasks which will use arguments from distFor.</p>
+</dd>
+<dt><a href="#distFor">distFor(srcPath, destPath)</a> ⇒ <code>*</code></dt>
+<dd><p>Build the distribution for a given source pattern.</p>
+</dd>
+<dt><a href="#distLint">distLint()</a> ⇒ <code>*</code></dt>
+<dd><p>Applies Standard code style linting to distribution files.</p>
+</dd>
+<dt><a href="#distMinify">distMinify()</a> ⇒ <code>*</code></dt>
+<dd><p>Creates minified versions of the dist files.</p>
+</dd>
+<dt><a href="#readmeTemplate">readmeTemplate()</a> ⇒ <code>*</code></dt>
+<dd><p>Copy a readme template into the README.md file.</p>
+</dd>
+<dt><a href="#testFull">testFull()</a> ⇒ <code>Promise.&lt;*&gt;</code></dt>
+<dd><p>Run all tests with jest.</p>
+</dd>
+<dt><a href="#testQuick">testQuick()</a> ⇒ <code>Promise.&lt;*&gt;</code></dt>
+<dd><p>Run the Jest tests for files which have been modified (based on git status).</p>
+</dd>
+<dt><a href="#watchFull">watchFull()</a> ⇒ <code>*</code></dt>
+<dd><p>Watch for changes and run the distribution for the changed files, then bundle and test the changed files.</p>
+</dd>
+<dt><a href="#watchTest">watchTest()</a> ⇒ <code>*</code></dt>
+<dd><p>Watch for changes and run the tests.</p>
+</dd>
+</dl>
+
+<a name="build"></a>
+
+## build
+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.
+
+**Kind**: global constant  
+<a name="compileReadme"></a>
+
+## compileReadme
+Generate the README.md file based off of the template, then append the generated documentation.
+
+**Kind**: global constant  
+<a name="defaultCmd"></a>
+
+## defaultCmd
+Recommended as the default task, runs the simple dist and bundle tasks.
+
+**Kind**: global constant  
+<a name="logObject"></a>
+
+## logObject
+Log out an object in a nicely formatted way.
+
+**Kind**: global constant  
+
+| Param | Type | Default |
+| --- | --- | --- |
+| object | <code>Object</code> |  | 
+| [label] | <code>string</code> | <code>&quot;&#x27;logging&#x27;&quot;</code> | 
+
+<a name="circularObject"></a>
+
+## circularObject : <code>Object.&lt;string, (string\|Object\|Array)&gt;</code>
+Multilayered node tree-like structure with parent references
+
+**Kind**: global constant  
+<a name="deepReferenceObject"></a>
+
+## deepReferenceObject : <code>Object.&lt;string, (string\|number\|Object)&gt;</code>
+Sample object with deep references.
+
+**Kind**: global constant  
+<a name="linkedList"></a>
+
+## linkedList : <code>Object.&lt;string, (string\|Object)&gt;</code>
+Sample LinkedList for testing circular references.
+
+**Kind**: global constant  
+<a name="jsonDom"></a>
+
+## jsonDom
+Sample of jsonDom object containing empty nested array and objects
+
+**Kind**: global constant  
+<a name="domItem"></a>
+
+## domItem
+Sample of domItem child with nested child and optional details
+
+**Kind**: global constant  
+<a name="multiReferenceObject"></a>
+
+## multiReferenceObject : <code>Object.&lt;string, (string\|number\|Object)&gt;</code>
+Sample of object containing multiple references.
+
+**Kind**: global constant  
+<a name="nodeTree"></a>
+
+## nodeTree : <code>Object.&lt;string, (string\|Object\|Array)&gt;</code>
+Sample NodeTree for testing circular references and arrays.
+
+**Kind**: global constant  
+<a name="addToReadme"></a>
+
+## addToReadme() ⇒ <code>string</code> \| <code>Uint8Array</code>
+Appends all the jsdoc comments to the readme file. Assumes empty or templated file.
+
+**Kind**: global function  
+<a name="bundle"></a>
+
+## bundle() ⇒ <code>\*</code>
+Starting at the distribution entry point, bundle all the files into a single file and store them in the specified output directory.
+
+**Kind**: global function  
+<a name="bundleLint"></a>
+
+## bundleLint() ⇒ <code>\*</code>
+Applies Standard code style linting to bundled file.
+
+**Kind**: global function  
+<a name="bundleMinify"></a>
+
+## bundleMinify() ⇒ <code>\*</code>
+Creates the minified bundle file.
+
+**Kind**: global function  
+<a name="clean"></a>
+
+## clean() ⇒ <code>Promise.&lt;Array.&lt;string&gt;&gt;</code> \| <code>\*</code>
+Deletes all the distribution and browser files (used before create a new build).
+
+**Kind**: global function  
+<a name="dist"></a>
+
+## dist() ⇒ <code>\*</code>
+Simplified distribution tasks which will use arguments from distFor.
+
+**Kind**: global function  
+<a name="distFor"></a>
+
+## distFor(srcPath, destPath) ⇒ <code>\*</code>
+Build the distribution for a given source pattern.
+
+**Kind**: global function  
+
+| Param | Type |
+| --- | --- |
+| srcPath | <code>string</code> \| <code>array</code> | 
+| destPath | <code>string</code> | 
+
+<a name="distLint"></a>
+
+## distLint() ⇒ <code>\*</code>
+Applies Standard code style linting to distribution files.
+
+**Kind**: global function  
+<a name="distMinify"></a>
+
+## distMinify() ⇒ <code>\*</code>
+Creates minified versions of the dist files.
+
+**Kind**: global function  
+<a name="readmeTemplate"></a>
+
+## readmeTemplate() ⇒ <code>\*</code>
+Copy a readme template into the README.md file.
+
+**Kind**: global function  
+<a name="testFull"></a>
+
+## testFull() ⇒ <code>Promise.&lt;\*&gt;</code>
+Run all tests with jest.
+
+**Kind**: global function  
+<a name="testQuick"></a>
+
+## testQuick() ⇒ <code>Promise.&lt;\*&gt;</code>
+Run the Jest tests for files which have been modified (based on git status).
+
+**Kind**: global function  
+<a name="watchFull"></a>
+
+## watchFull() ⇒ <code>\*</code>
+Watch for changes and run the distribution for the changed files, then bundle and test the changed files.
+
+**Kind**: global function  
+<a name="watchTest"></a>
+
+## watchTest() ⇒ <code>\*</code>
+Watch for changes and run the tests.
+
+**Kind**: global function  

package/babel.config.js

@@ -1,4 +1,7 @@
 module.exports = {
+  plugins: [
+    '@babel/plugin-proposal-throw-expressions'
+  ],
   presets: [
     ['@babel/preset-env', {
       useBuiltIns: 'usage',

package/functions/addToReadme.js

@@ -6,7 +6,7 @@ const { src } = require('gulp')
 
 /**
  * Appends all the jsdoc comments to the readme file. Assumes empty or templated file.
- * @returns {*}
+ * @returns {string|Uint8Array}
  */
 const addToReadme = () => src(gulpConfig.srcSearch)
   .pipe(filenames('readme'))

package/functions/build.js

@@ -7,6 +7,7 @@ const dist = require('./dist')
 const distLint = require('./distLint')
 const distMinify = require('./distMinify')
 const { parallel, series } = require('gulp')
+const gulpConfig = require('../gulp.config.js')
 const testFull = require('./testFull')
 
 /**
@@ -14,7 +15,9 @@ const testFull = require('./testFull')
  * Cleans, distributes (lint and minify), bundles (lint and minify), creates the readme, then runs the tests.
  */
 const build = parallel(
-  series(clean, dist, parallel(distLint, distMinify), bundle, parallel(bundleLint, bundleMinify)),
+  gulpConfig.nodeOnly
+    ? series(clean, dist, parallel(distLint, distMinify))
+    : series(clean, dist, parallel(distLint, distMinify), bundle, parallel(bundleLint, bundleMinify)),
   compileReadme,
   testFull
 )

package/functions/default.js

@@ -1,10 +1,11 @@
 const { series } = require('gulp')
 const dist = require('./dist')
 const bundle = require('./bundle')
+const gulpConfig = require('../gulp.config')
 
 /**
  * Recommended as the default task, runs the simple dist and bundle tasks.
  */
-const defaultCmd = series(dist, bundle)
+const defaultCmd = gulpConfig.nodeOnly ? series(dist) : series(dist, bundle)
 
 module.exports = defaultCmd

package/functions/testHelpers.js

@@ -0,0 +1,142 @@
+/**
+ * Log out an object in a nicely formatted way.
+ * @param {Object} object
+ * @param {string} [label='logging']
+ */
+export const logObject = (object, label = 'logging') => {
+  if (typeof require === 'undefined') {
+    console.log(label, object)
+    return
+  }
+  console.log(label, require('util').inspect(object, false, null, true))
+}
+
+/**
+ * Multilayered node tree-like structure with parent references
+ * @type {Object.<string, string|Object|Array>}
+ */
+export const circularObject = { name: 'root', parent: {}, body: {}, head: {}, children: [] }
+circularObject.children = [
+  { name: 'body', parent: {}, children: [] },
+  { name: 'head', parent: {}, children: [] }
+]
+circularObject.body = circularObject.children[0]
+circularObject.head = circularObject.children[1]
+circularObject.body.parent = circularObject
+circularObject.head.parent = circularObject
+circularObject.body.children = [
+  { name: 'body child one', parent: {}, children: [] },
+  { name: 'body child two', parent: {}, children: [] }
+]
+circularObject.body.children[0].parent = circularObject.body
+circularObject.body.children[1].parent = circularObject.body
+circularObject.head.children = [
+  { name: 'head child one', parent: {}, children: [] },
+  { name: 'head child two', parent: {}, children: [] }
+]
+circularObject.head.children[0].parent = circularObject.head
+circularObject.head.children[1].parent = circularObject.head
+
+/**
+ * Sample object with deep references.
+ * @type {Object.<string, string|number|Object>}
+ */
+export const deepReferenceObject = {
+  object1: {
+    name: 'someName',
+    object2: {
+      age: 12,
+      array1: [
+        'someString',
+        'anotherString'
+      ]
+    },
+    array2: [
+      89,
+      32
+    ]
+  },
+  title: 'Some Title',
+  item: 45
+}
+
+/**
+ * Sample LinkedList for testing circular references.
+ * @type {Object.<string, string|Object>}
+ */
+export const linkedList = { name: 'one', prev: null, next: null }
+linkedList.next = { name: 'two', prev: linkedList, next: null }
+linkedList.next.next = { name: 'three', prev: linkedList.next, next: null }
+
+/**
+ * Sample of jsonDom object containing empty nested array and objects
+ */
+export const jsonDom = {
+  tagName: 'div',
+  attributes: { style: {}, className: 'column' },
+  element: null,
+  eventListeners: {},
+  parentItem: {},
+  children: [],
+  axis: 'x'
+}
+
+/**
+ * Sample of domItem child with nested child and optional details
+ */
+export const domItem = [
+  {
+    attributes: { className: 'row', style: {} },
+    axis: 'y',
+    children: [
+      {
+        attributes: { style: {} },
+        axis: 'x',
+        children: [],
+        element: {},
+        eventListeners: {},
+        hasShip: false,
+        isHit: false,
+        parentItem: {},
+        point: {},
+        tagName: 'div'
+      }
+    ],
+    element: null,
+    eventListeners: {},
+    parentItem: {},
+    tagName: 'div'
+  }
+]
+
+/**
+ * Sample of object containing multiple references.
+ * @type {Object.<string, string|number|Object>}
+ */
+export const multiReferenceObject = {
+  object1: {
+    name: 'someName'
+  },
+  object2: {
+    age: 12
+  },
+  array1: [
+    'someString',
+    'anotherString'
+  ],
+  array2: [
+    89,
+    32
+  ],
+  title: 'Some Title',
+  item: 45
+}
+
+/**
+ * Sample NodeTree for testing circular references and arrays.
+ * @type {Object.<string, string|Object|Array>}
+ */
+export const nodeTree = { name: 'one', parent: null, children: [] }
+nodeTree.children[0] = { name: 'child one', parent: nodeTree, children: [] }
+nodeTree.children[1] = { name: 'child two', parent: nodeTree, children: [] }
+nodeTree.children[0].children[0] = { name: 'grandchild one', parent: nodeTree.children[0], children: [] }

package/functions/testHelpers.test.js

@@ -0,0 +1,100 @@
+const {
+  circularObject,
+  deepReferenceObject,
+  domItem,
+  jsonDom,
+  linkedList,
+  logObject,
+  multiReferenceObject,
+  nodeTree
+} = require('./testHelpers.js')
+const util = require('util')
+
+describe('testHelpers', () => {
+  test('can nicely output objects with logObject', () => {
+    const logSpy = jest.spyOn(console, 'log')
+    const inspectSpy = jest.spyOn(util, 'inspect')
+    const someObject = { one: 1, two: 2, three: 3 }
+    logObject(someObject, 'someObject')
+    expect(inspectSpy).toHaveBeenCalledWith(someObject, false, null, true)
+    expect(logSpy).toHaveBeenCalledWith('someObject', util.inspect(someObject, false, null, true))
+  })
+
+  test('has sample circular object', () => {
+    expect(circularObject.body.parent).toBe(circularObject)
+    expect(circularObject.body.children[0].parent).toBe(circularObject.body)
+    expect(circularObject.body.children[1].parent).toBe(circularObject.body)
+    expect(circularObject.children[0]).toBe(circularObject.body)
+    expect(circularObject.head.parent).toBe(circularObject)
+    expect(circularObject.head.children[0].parent).toBe(circularObject.head)
+    expect(circularObject.head.children[1].parent).toBe(circularObject.head)
+    expect(circularObject.children[1]).toBe(circularObject.head)
+  })
+
+  test('has sample deep reference object', () => {
+    expect(deepReferenceObject).toHaveProperty('object1.object2.array1')
+  })
+
+  test('has sample domItem object', () => {
+    expect(domItem[0]).toHaveProperty('attributes')
+    expect(domItem[0]).toHaveProperty('children')
+    expect(domItem[0]).toHaveProperty('element')
+    expect(domItem[0]).toHaveProperty('eventListeners')
+    expect(domItem[0]).toHaveProperty('parentItem')
+    expect(domItem[0]).toHaveProperty('tagName')
+  })
+
+  test('has sample jsonDom object', () => {
+    expect(jsonDom).toHaveProperty('attributes')
+    expect(jsonDom).toHaveProperty('children')
+    expect(jsonDom).toHaveProperty('element')
+    expect(jsonDom).toHaveProperty('eventListeners')
+    expect(jsonDom).toHaveProperty('parentItem')
+    expect(jsonDom).toHaveProperty('tagName')
+  })
+
+  test('has sample linkedList object', () => {
+    expect(linkedList.name).toBe('one')
+    expect(linkedList).toHaveProperty('prev')
+    expect(linkedList.prev).toBeNull()
+
+    expect(linkedList).toHaveProperty('next')
+    expect(linkedList.next.name).toBe('two')
+    expect(linkedList).toHaveProperty('next.prev')
+    expect(linkedList.next.prev).toBe(linkedList)
+
+    expect(linkedList).toHaveProperty('next.next')
+    expect(linkedList.next.next.name).toBe('three')
+    expect(linkedList).toHaveProperty('next.prev')
+    expect(linkedList.next.next.prev).toBe(linkedList.next)
+
+    expect(linkedList).toHaveProperty('next.next.next')
+    expect(linkedList.next.next.next).toBeNull()
+  })
+
+  test('has sample multiReferenceObject object', () => {
+    expect(multiReferenceObject).toHaveProperty('object1.name')
+    expect(multiReferenceObject).toHaveProperty('object2.age')
+    expect(multiReferenceObject).toHaveProperty('array1.0')
+    expect(multiReferenceObject).toHaveProperty('array1.1')
+    expect(multiReferenceObject).toHaveProperty('array2.0')
+    expect(multiReferenceObject).toHaveProperty('array2.1')
+    expect(multiReferenceObject).toHaveProperty('title')
+    expect(multiReferenceObject).toHaveProperty('item')
+  })
+
+  test('has sample nodeTree object', () => {
+    expect(nodeTree.name).toBe('one')
+    expect(nodeTree.parent).toBeNull()
+    expect(nodeTree.children.length).toBe(2)
+    expect(nodeTree.children[0].name).toBe('child one')
+    expect(nodeTree.children[0].parent).toBe(nodeTree)
+    expect(nodeTree.children[0].children.length).toBe(1)
+    expect(nodeTree.children[0].children[0].name).toBe('grandchild one')
+    expect(nodeTree.children[0].children[0].parent).toBe(nodeTree.children[0])
+    expect(nodeTree.children[0].children[0].children.length).toBe(0)
+    expect(nodeTree.children[1].name).toBe('child two')
+    expect(nodeTree.children[1].parent).toBe(nodeTree)
+    expect(nodeTree.children[1].children.length).toBe(0)
+  })
+})

package/gulp.config.js

@@ -1,16 +1,27 @@
-const parentConfig = require('../../build-tools.config.js')
 const defaultConfig = (config, path, defaultValue) => {
   if (typeof config[path] === 'undefined') {
     return defaultValue
   }
   return config[path]
 }
+let parentConfig = {}
+try {
+  parentConfig = require('../../build-tools.config.js')
+} catch (isUndefined) {
+  try {
+    parentConfig = require('./build-tools.config.js')
+    console.info('Missing main project config, using default path')
+  } catch (stillUndefined) {
+    console.warn('Missing config path, ensure you have a build-tools.config.js file in you project root')
+  }
+}
 module.exports = {
   browserName: defaultConfig(parentConfig, 'browserName', 'default'),
   browserPath: defaultConfig(parentConfig, 'browserPath', 'browser'),
   distMain: defaultConfig(parentConfig, 'distMain', 'dist/main'),
   distPath: defaultConfig(parentConfig, 'distPath', 'dist'),
   distSearch: defaultConfig(parentConfig, 'distSearch', 'dist/**/*.js'),
+  nodeOnly: defaultConfig(parentConfig, 'nodeOnly', false),
   readmeTemplate: defaultConfig(parentConfig, 'readmeTemplate', 'MAIN.md'),
   srcPath: defaultConfig(parentConfig, 'srcPath', 'src'),
   srcSearch: defaultConfig(parentConfig, 'srcSearch', 'src/**/!(*.test).js'),

package/package.json

@@ -1,10 +1,18 @@
 {
   "name": "js-build-tools",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "Standardised build process with gulp.",
   "main": "gulpfile.base.js",
   "scripts": {
-    "resolutions": "npx npm-force-resolutions"
+    "build": "gulp build",
+    "dev": "gulp",
+    "htmldocs": "jsdoc -R MAIN.md -c ./.jsdoc.conf.js -d docs",
+    "readme": "gulp readme",
+    "resolutions": "npx npm-force-resolutions",
+    "test": "gulp testFull",
+    "test:quick": "gulp testQuick",
+    "watch": "gulp watchFull",
+    "watch:test": "gulp watchTest"
   },
   "repository": "github:jheagle/js-build-tools",
   "keywords": [
@@ -25,31 +33,26 @@
     ]
   },
   "dependencies": {
-    "@babel/core": "^7.18.6",
-    "@babel/preset-env": "^7.18.6",
-    "@babel/runtime-corejs3": "^7.18.6",
-    "babel-jest": "^28.1.2",
+    "@babel/core": "^7.18.13",
+    "@babel/plugin-proposal-throw-expressions": "^7.18.6",
+    "@babel/preset-env": "^7.18.10",
+    "@babel/runtime-corejs3": "^7.18.9",
+    "babel-jest": "^29.0.1",
     "browserify": "^17.0.0",
-    "core-js": "^3.23.3",
+    "core-js": "^3.25.0",
     "del": "^6.1.1",
     "fs": "^0.0.1-security",
-    "glob-parent": "^5.1.2",
     "gulp": "^4.0.2",
     "gulp-babel": "^8.0.0",
     "gulp-filenames": "^4.0.1",
     "gulp-rename": "^2.0.0",
     "gulp-standard": "^14.0.0",
     "gulp-uglify-es": "^3.0.0",
-    "jest": "^28.1.2",
+    "jest": "^29.0.1",
     "jsdoc-to-markdown": "^7.1.1",
-    "lodash.template": "^4.5.0",
     "regenerator-runtime": "^0.13.9",
     "vinyl-source-stream": "^2.0.0"
   },
-  "resolutions": {
-    "glob-parent": "5.1.2",
-    "lodash.template": "4.5.0"
-  },
   "files": [
     "babel.config.js",
     "functions",