js-build-tools 1.0.5 → 1.1.0

package/dist/watchFull.js

@@ -0,0 +1,42 @@
+'use strict'
+
+require('core-js/modules/es.regexp.constructor.js')
+
+require('core-js/modules/es.regexp.exec.js')
+
+require('core-js/modules/es.regexp.sticky.js')
+
+require('core-js/modules/es.regexp.to-string.js')
+
+require('core-js/modules/es.string.replace.js')
+
+var bundle = require('./bundle')
+
+var distFor = require('./distFor')
+
+var gulpConfig = require('../gulp.config.js')
+
+var _require = require('gulp')
+var parallel = _require.parallel
+var series = _require.series
+var watch = _require.watch
+
+var testQuick = require('./testQuick')
+/**
+ * Watch for changes and run the distribution for the changed files, then bundle and test the changed files.
+ * @returns {*}
+ */
+
+var watchFull = function watchFull () {
+  return watch(gulpConfig.watchSearch).on('change', function (path) {
+    var pathRegex = new RegExp('^'.concat(gulpConfig.srcPath, '(.*\\/).+\\.js$'), 'i')
+
+    var distForPath = function distForPath () {
+      return distFor(path, path.replace(pathRegex, ''.concat(gulpConfig.distPath, '$1')))
+    }
+
+    return parallel(testQuick, series(distForPath, bundle))()
+  })
+}
+
+module.exports = watchFull

package/dist/watchFull.min.js

@@ -0,0 +1 @@
+"use strict";require("core-js/modules/es.regexp.constructor.js"),require("core-js/modules/es.regexp.exec.js"),require("core-js/modules/es.regexp.sticky.js"),require("core-js/modules/es.regexp.to-string.js"),require("core-js/modules/es.string.replace.js");var bundle=require("./bundle"),distFor=require("./distFor"),gulpConfig=require("../gulp.config.js"),_require=require("gulp"),parallel=_require.parallel,series=_require.series,watch=_require.watch,testQuick=require("./testQuick"),watchFull=function(){return watch(gulpConfig.watchSearch).on("change",(function(e){var r=new RegExp("^".concat(gulpConfig.srcPath,"(.*\\/).+\\.js$"),"i");return parallel(testQuick,series((function(){return distFor(e,e.replace(r,"".concat(gulpConfig.distPath,"$1")))}),bundle))()}))};module.exports=watchFull;

package/dist/watchTest.js

@@ -0,0 +1,21 @@
+'use strict'
+
+var gulpConfig = require('../gulp.config.js')
+
+var _require = require('gulp')
+var series = _require.series
+var watch = _require.watch
+
+var testQuick = require('./testQuick')
+/**
+ * Watch for changes and run the tests.
+ * @returns {*}
+ */
+
+var watchTest = function watchTest () {
+  return watch(gulpConfig.watchSearch, {
+    ignoreInitial: false
+  }, series(testQuick))
+}
+
+module.exports = watchTest

package/dist/watchTest.min.js

@@ -0,0 +1 @@
+"use strict";var gulpConfig=require("../gulp.config.js"),_require=require("gulp"),series=_require.series,watch=_require.watch,testQuick=require("./testQuick"),watchTest=function(){return watch(gulpConfig.watchSearch,{ignoreInitial:!1},series(testQuick))};module.exports=watchTest;

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.1.0",
   "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,33 +33,29 @@
     ]
   },
   "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",
+    "dist",
     "functions",
     "gulpfile.base.js",
     "gulp.config.js"