js-build-tools 1.2.3 → 2.1.1

package/functions/partials/minifyFor.test.js

@@ -0,0 +1,48 @@
+const fs = require('fs')
+const setUp = require('../test-helpers/setUp')
+setUp.setDefaults('test-minify-for')
+const gulpConfig = setUp.gulpConfig
+const minifyFor = require('./minifyFor')
+const { countMatches } = require('../testHelpers')
+
+const rawContents = 'const { dest, src } = require(\'gulp\')\n' +
+  'const { default: uglify } = require(\'gulp-uglify-es\')\n' +
+  'const rename = require(\'gulp-rename\')\n' +
+  '\n' +
+  '/**\n' +
+  ' * Minify files and rename the output with \'.min\' extension.\n' +
+  ' * @returns {*}\n' +
+  ' */\n' +
+  'const minifyFor = (srcSearch, destination) => src(srcSearch)\n' +
+  '  .pipe(uglify())\n' +
+  '  .pipe(rename({ extname: \'.min.js\' }))\n' +
+  '  .pipe(dest(destination))\n' +
+  '\n' +
+  'module.exports = minifyFor\n'
+
+beforeEach(() => setUp.beforeEach()
+  .then(() => fs.writeFileSync(gulpConfig.get('srcPath') + '/minifyFor.js', rawContents)))
+
+afterEach(setUp.afterEach)
+
+describe('minifyFor', () => {
+  test('copies the src directory and minifies it into the dist directory with min extension', done => {
+    const srcPath = gulpConfig.get('srcPath')
+    const filePath = `${srcPath}/minifyFor.js`
+    const expectedFilePath = `${srcPath}/minifyFor.min.js`
+    expect.assertions(3)
+    const oldContents = fs.readFileSync(filePath).toString()
+    expect(countMatches(oldContents, '\n')).toBe(14)
+    minifyFor(filePath, srcPath)
+      .on('finish', () => {
+        expect(fs.existsSync(expectedFilePath)).toBeTruthy()
+        const minifiedContents = fs.readFileSync(expectedFilePath).toString()
+        expect(countMatches(minifiedContents, '\n')).toBe(0)
+        done()
+      })
+      .on('error', error => {
+        console.error('Encountered error', error)
+        done()
+      })
+  })
+})

package/functions/partials/readmeTemplate.js

@@ -0,0 +1,15 @@
+const { dest, src } = require('gulp')
+const gulpConfig = require('../../gulp.config.js')
+const rename = require('gulp-rename')
+
+/**
+ * Copy a readme template into the README.md file.
+ * @function
+ * @memberOf module:partials
+ * @returns {*}
+ */
+const readmeTemplate = () => src(gulpConfig.get('readmeTemplate'))
+  .pipe(rename(gulpConfig.get('readmeFile')))
+  .pipe(dest(gulpConfig.get('readmePath')))
+
+module.exports = readmeTemplate

package/functions/partials/readmeTemplate.test.js

@@ -0,0 +1,33 @@
+const fs = require('fs')
+const setUp = require('../test-helpers/setUp')
+setUp.setDefaults('test-readme-template')
+const gulpConfig = setUp.gulpConfig
+const readmeTemplate = require('./readmeTemplate')
+
+const mainMd = 'MAIN.md'
+const mainTestPath = gulpConfig.get('readmeTemplate')
+
+beforeEach(() => setUp.beforeEach()
+  .then(() => fs.copyFileSync(mainMd, mainTestPath)))
+
+afterEach(setUp.afterEach)
+
+describe('readmeTemplate', () => {
+  test('copies the main contents into the new README.md', done => {
+    const readmeFilePath = gulpConfig.get('readmePath') + gulpConfig.get('readmeFile')
+    const mainContents = fs.readFileSync(mainTestPath)
+    expect.assertions(2)
+    readmeTemplate()
+      .on('finish', async () => {
+        await expect(fs.existsSync(readmeFilePath)).toBeTruthy()
+        const readme = await fs.readFileSync(readmeFilePath)
+        // Confirm that the contents for MAIN.md are copied to README.md
+        await expect(readme).toEqual(mainContents)
+        done()
+      })
+      .on('error', error => {
+        console.error('Encountered error', error)
+        done()
+      })
+  })
+})

package/functions/partials/runOnChange.js

@@ -0,0 +1,57 @@
+const gulpConfig = require('../../gulp.config.js')
+const bundle = require('../bundle')
+const distSeries = require('./distSeries')
+const { parallel, series } = require('gulp')
+const testQuick = require('../testQuick')
+
+/**
+ * Run this function when the watched files are modified.
+ * 1. Find the sub-folders within src path
+ * 2. Maintain the folders, but use distPath for base
+ * 3. Remove base folder and return dist path with correct sub-folders
+ * @example
+ * // Configured paths
+ * distPath = 'dist'
+ * srcPath = 'functions'
+ *
+ * // Path parameter
+ * path = 'functions/some/path/file.js'
+ *
+ * // Generated regex using configured srcPath
+ * pathRegex = '/^functions(.*\/).+\.js$/i'
+ *
+ * // Replace value using the configured distPath
+ * replacePath = 'dist$1'
+ *
+ * // The resulting replaced path for the destination folder
+ * distPathResult = 'dist/some/path/'
+ * @function
+ * @memberOf module:partials
+ * @param {string} path
+ * @returns {stream.Stream}
+ */
+const runOnChange = path => {
+  const useTs = gulpConfig.get('useTsConfig')
+  const distPath = gulpConfig.get('distPath')
+  const srcPath = gulpConfig.get('srcPath')
+  /**
+   * 1. The original path comes in from src and is a .ts
+   * 2. Discover the outgoing dist path where that file should go
+   * 3. Use the path and dist in tsFor
+   * 4. Take the original path, convert to full file path in dist
+   * 5. Use the dist path found previously in #2
+   * 6. Use the full dist path and the dist outgoing path in distFor
+   */
+  const pathRegex = new RegExp(`^${srcPath}(.*\\/)(.+)\\.(js|ts)$`, 'i')
+  const distPathResult = path.replace(pathRegex, `${distPath}$1`)
+  let distSrcPath = path
+  if (useTs) {
+    distSrcPath = path.replace(pathRegex, `${distPath}$1$2.js`)
+  }
+  const runSeries = distSeries(distSrcPath, distPathResult, path)
+  return gulpConfig.get('nodeOnly')
+    ? series(testQuick, runSeries)()
+    : parallel(testQuick, series(runSeries, bundle))()
+}
+
+module.exports = runOnChange

package/functions/partials/runOnChange.test.js

@@ -0,0 +1,93 @@
+const fs = require('fs')
+const setUp = require('../test-helpers/setUp')
+setUp.setDefaults('test-run-on-change')
+const gulpConfig = setUp.gulpConfig
+const bundle = require('../bundle')
+const distFor = require('./distFor')
+const runOnChange = require('./runOnChange')
+const tsFor = require('./tsFor')
+const testQuick = require('../testQuick')
+
+const genericFunction = () => Promise.resolve(true)
+
+jest.mock('../bundle', () => jest.fn(genericFunction))
+jest.mock('./distFor', () => jest.fn(genericFunction))
+jest.mock('./tsFor', () => jest.fn(genericFunction))
+jest.mock('../testQuick', () => jest.fn(genericFunction))
+
+const rawContents = 'export function sayHello(name: string) {\n' +
+  '  return `Hello from ${name}`;\n' +
+  '}'
+
+const distPath = gulpConfig.get('distPath') + '/'
+const srcPath = gulpConfig.get('srcPath')
+const srcFile = `${srcPath}/runOnChange.js`
+const srcTsFile = `${srcPath}/runOnChange.ts`
+
+beforeEach(() => {
+    return setUp.beforeEach()
+      .then(() => fs.writeFileSync(srcTsFile, rawContents))
+      .then(() => fs.writeFileSync(srcFile, rawContents))
+  }
+)
+
+afterEach(() => {
+  jest.clearAllMocks()
+  return setUp.afterEach()
+})
+
+describe('runOnChange', () => {
+  test('runs testQuick and distFor for nodeOnly true and useTs false', done => {
+    gulpConfig.set('nodeOnly', true)
+    gulpConfig.set('useTsConfig', false)
+    expect.assertions(2)
+    runOnChange(srcFile)
+    setTimeout(() => {
+      expect(testQuick).toHaveBeenCalled()
+      expect(distFor).toHaveBeenCalledWith(srcFile, distPath)
+      done()
+    }, 500)
+  })
+
+  test('runs testQuick and distFor for nodeOnly true and tsFor for useTs true', done => {
+    gulpConfig.set('nodeOnly', true)
+    gulpConfig.set('useTsConfig', true)
+    const distSrcPath = distPath + 'runOnChange.js'
+    expect.assertions(3)
+    runOnChange(srcTsFile)
+    setTimeout(() => {
+      expect(testQuick).toHaveBeenCalled()
+      expect(tsFor).toHaveBeenCalledWith(srcTsFile, distPath)
+      expect(distFor).toHaveBeenCalledWith(distSrcPath, distPath)
+      done()
+    }, 500)
+  })
+
+  test('runs testQuick and distFor then bundle for nodeOnly false and useTs false', done => {
+    gulpConfig.set('nodeOnly', false)
+    gulpConfig.set('useTsConfig', false)
+    expect.assertions(3)
+    runOnChange(srcFile)
+    setTimeout(() => {
+      expect(testQuick).toHaveBeenCalled()
+      expect(distFor).toHaveBeenCalledWith(srcFile, distPath)
+      expect(bundle).toHaveBeenCalled()
+      done()
+    }, 500)
+  })
+
+  test('runs testQuick and distFor then bundle for nodeOnly false and tsFor for useTs true', done => {
+    gulpConfig.set('nodeOnly', false)
+    gulpConfig.set('useTsConfig', true)
+    const distSrcPath = distPath + 'runOnChange.js'
+    expect.assertions(4)
+    runOnChange(srcTsFile)
+    setTimeout(() => {
+      expect(testQuick).toHaveBeenCalled()
+      expect(tsFor).toHaveBeenCalledWith(srcTsFile, distPath)
+      expect(distFor).toHaveBeenCalledWith(distSrcPath, distPath)
+      expect(bundle).toHaveBeenCalled()
+      done()
+    }, 500)
+  })
+})

package/functions/partials/tsFor.js

@@ -0,0 +1,21 @@
+const { dest, src } = require('gulp')
+const gulpConfig = require('../../gulp.config.js')
+const ts = require('gulp-typescript')
+
+const tsProject = ts.createProject(gulpConfig.get('useTsConfig'))
+
+/**
+ * Starting at the source directory, find all the ts files and convert them into the distribution directory.
+ * @function
+ * @memberOf module:partials
+ * @param {string|array} [srcPath='']
+ * @param {string} [distPath='']
+ * @returns {stream.Stream}
+ * @see `https://www.typescriptlang.org/docs/handbook/gulp.html` for more info
+ */
+const tsFor = (srcPath = gulpConfig.get('tsSearch'), distPath = gulpConfig.get('distPath')) => src(srcPath)
+  .pipe(tsProject())
+  .js
+  .pipe(dest(distPath))
+
+module.exports = tsFor

package/functions/partials/tsFor.test.js

@@ -0,0 +1,44 @@
+const fs = require('fs')
+const setUp = require('../test-helpers/setUp')
+setUp.setDefaults('test-ts-for')
+const gulpConfig = setUp.gulpConfig
+const tsFor = require('./tsFor')
+const { countMatches, logObject } = require('../testHelpers')
+
+const rawContents = 'export function sayHello(name: string) {\n' +
+  '  return `Hello from ${name}`;\n' +
+  '}'
+
+beforeEach(
+  () => setUp.beforeEach()
+    .then(
+      async () => {
+        const srcPath = gulpConfig.get('srcPath')
+        return fs.writeFileSync(`${srcPath}/typeScript.ts`, rawContents)
+      }
+    )
+)
+
+afterEach(setUp.afterEach)
+
+describe('tsFor', () => {
+  test('copies the src directory and compiles it into the dist directory', done => {
+    const distPath = gulpConfig.get('distPath')
+    const srcPath = gulpConfig.get('srcPath')
+    const srcFile = `${srcPath}/typeScript.ts`
+    expect.assertions(3)
+    const oldContents = fs.readFileSync(srcFile).toString()
+    expect(countMatches(oldContents, 'sayHello(name: string)')).toEqual(1)
+    tsFor(srcFile, distPath)
+      .on('finish', () => {
+        expect(fs.existsSync(distPath)).toBeTruthy()
+        const compiledContents = fs.readFileSync(`${distPath}/typeScript.js`).toString()
+        expect(countMatches(compiledContents, 'sayHello(name)')).toEqual(1)
+        done()
+      })
+      .on('error', error => {
+        console.error('Encountered error', error)
+        done()
+      })
+  }, 30000)
+})

package/functions/partials.js

@@ -0,0 +1,32 @@
+/**
+ * Micro-functions used as components for the main gulp functions.
+ * @file
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 2.0.0
+ * @module partials
+ * @memberOf module:js-build-tools
+ */
+
+const addToReadme = require('./partials/addToReadme')
+const beginWatcher = require('./partials/beginWatcher')
+const clean = require('./partials/clean')
+const distFor = require('./partials/distFor')
+const distForSrc = require('./partials/distForSrc')
+const distSeries = require('./partials/distSeries')
+const minifyFor = require('./partials/minifyFor')
+const readmeTemplate = require('./partials/readmeTemplate')
+const runOnChange = require('./partials/runOnChange')
+const tsFor = require('./partials/tsFor')
+
+module.exports = {
+  addToReadme,
+  beginWatcher,
+  clean,
+  distFor,
+  distForSrc,
+  distSeries,
+  minifyFor,
+  readmeTemplate,
+  runOnChange,
+  tsFor,
+}

package/functions/partials.test.js

@@ -0,0 +1,7 @@
+const partials = require('./partials')
+
+describe('partials', () => {
+  test('is object with all partial exports', () => {
+    expect(Object.keys(partials).length).toBe(10)
+  })
+})

package/functions/test-helpers/circularObject.js

@@ -0,0 +1,28 @@
+/**
+ * Multilayered node tree-like structure with parent references
+ * @memberOf module:testHelpers
+ * @type {Object.<string, string|Object|Array>}
+ */
+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
+
+module.exports = circularObject

package/functions/test-helpers/circularObject.test.js

@@ -0,0 +1,14 @@
+import circularObject from './circularObject'
+
+describe('circularObject', () => {
+  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)
+  })
+})

package/functions/test-helpers/countMatches.js

@@ -0,0 +1,11 @@
+/**
+ * Simple way to count string occurrences for testing.
+ * @function
+ * @memberOf module:testHelpers
+ * @param {string} content
+ * @param {string} search
+ * @returns {number}
+ */
+const countMatches = (content, search) => content.split(search).length - 1
+
+module.exports =  countMatches

package/functions/test-helpers/countMatches.test.js

@@ -0,0 +1,9 @@
+const countMatches = require('./countMatches')
+
+describe('countMatches', () => {
+  test('can get count of string occurrences', () => {
+    const find = 'find me'
+    const sampleString = `${find} in some string that could change the times ${find} will occur here, ${find} should be found three times`
+    expect(countMatches(sampleString, find)).toBe(3)
+  })
+})

package/functions/test-helpers/deepReferenceObject.js

@@ -0,0 +1,25 @@
+/**
+ * Sample object with deep references.
+ * @memberOf module:testHelpers
+ * @type {Object.<string, string|number|Object>}
+ */
+const deepReferenceObject = {
+  object1: {
+    name: 'someName',
+    object2: {
+      age: 12,
+      array1: [
+        'someString',
+        'anotherString'
+      ]
+    },
+    array2: [
+      89,
+      32
+    ]
+  },
+  title: 'Some Title',
+  item: 45
+}
+
+module.exports = deepReferenceObject

package/functions/test-helpers/deepReferenceObject.test.js

@@ -0,0 +1,7 @@
+const deepReferenceObject = require('./deepReferenceObject')
+
+describe('deepReferenceObject', () => {
+  test('has sample deep reference object', () => {
+    expect(deepReferenceObject).toHaveProperty('object1.object2.array1')
+  })
+})

package/functions/test-helpers/domItem.js

@@ -0,0 +1,31 @@
+/**
+ * Sample of domItem child with nested child and optional details
+ * @memberOf module:testHelpers
+ * @type {Object.<string, string|number|Array|Object>}
+ */
+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'
+  }
+]
+
+module.exports = domItem

package/functions/test-helpers/domItem.test.js

@@ -0,0 +1,12 @@
+const domItem = require('./domItem')
+
+describe('domItem', () => {
+  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')
+  })
+})

package/functions/test-helpers/jsonDom.js

@@ -0,0 +1,16 @@
+/**
+ * Sample of jsonDom object containing empty nested array and objects
+ * @memberOf module:testHelpers
+ * @type {Object.<string, string|number|Array|Object>}
+ */
+const jsonDom = {
+  tagName: 'div',
+  attributes: { style: {}, className: 'column' },
+  element: null,
+  eventListeners: {},
+  parentItem: {},
+  children: [],
+  axis: 'x'
+}
+
+module.exports = jsonDom

package/functions/test-helpers/jsonDom.test.js

@@ -0,0 +1,12 @@
+const jsonDom = require('./jsonDom')
+
+describe('jsonDom', () => {
+  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')
+  })
+})

package/functions/test-helpers/linkedList.js

@@ -0,0 +1,10 @@
+/**
+ * Sample LinkedList for testing circular references.
+ * @memberOf module:testHelpers
+ * @type {Object.<string, string|Object>}
+ */
+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 }
+
+module.exports = linkedList

package/functions/test-helpers/linkedList.test.js

@@ -0,0 +1,22 @@
+const linkedList = require('./linkedList')
+
+describe('linkedList', () => {
+  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()
+  })
+})

package/functions/test-helpers/logObject.js

@@ -0,0 +1,18 @@
+/**
+ * Log out an object in a nicely formatted way.
+ * @function
+ * @memberOf module:testHelpers
+ * @param {Object} object
+ * @param {string} [label=logging]
+ * @param {string} [outputType=log]
+ * @returns {string|undefined}
+ */
+const logObject = (object, label = 'logging', outputType = 'log') => {
+  const logger = outputType === 'string' ? (label, object) => `'${label}' | ` + JSON.stringify(object) : console[outputType]
+  if (typeof require === 'undefined' || outputType === 'string') {
+    return logger(label, object)
+  }
+  return logger(label, require('util').inspect(object, false, null, true))
+}
+
+module.exports = logObject

package/functions/test-helpers/logObject.test.js

@@ -0,0 +1,20 @@
+const logObject = require('./logObject')
+const util = require('util')
+
+describe('logObject', () => {
+  test('can nicely output objects', () => {
+    const logSpy = jest.spyOn(console, 'log').mockImplementation(jest.fn())
+    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('output to string when that argument is provided', () => {
+    const someObject = { one: 1, two: 2, three: 3 }
+    const label = 'someObject'
+    const result = logObject(someObject, label, 'string')
+    expect(result).toEqual(`'${label}' | ` + JSON.stringify(someObject))
+  })
+})

package/functions/test-helpers/multiReferenceObject.js

@@ -0,0 +1,25 @@
+/**
+ * Sample of object containing multiple references.
+ * @memberOf module:testHelpers
+ * @type {Object.<string, string|number|Object>}
+ */
+const multiReferenceObject = {
+  object1: {
+    name: 'someName'
+  },
+  object2: {
+    age: 12
+  },
+  array1: [
+    'someString',
+    'anotherString'
+  ],
+  array2: [
+    89,
+    32
+  ],
+  title: 'Some Title',
+  item: 45
+}
+
+module.exports = multiReferenceObject

package/functions/test-helpers/multiReferenceObject.test.js

@@ -0,0 +1,14 @@
+const multiReferenceObject = require('./multiReferenceObject')
+
+describe('multiReferenceObject', () => {
+  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')
+  })
+})

package/functions/test-helpers/nodeTree.js

@@ -0,0 +1,11 @@
+/**
+ * Sample NodeTree for testing circular references and arrays.
+ * @memberOf module:testHelpers
+ * @type {Object.<string, string|Object|Array>}
+ */
+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: [] }
+
+module.exports = nodeTree