js-build-tools 1.2.2 → 1.2.3

package/functions/compileReadme.js

@@ -1,10 +1,10 @@
-const addToReadme = require('./addToReadme')
-const readmeTemplate = require('./readmeTemplate')
-const { series } = require('gulp')
-
-/**
- * Generate the README.md file based off of the template, then append the generated documentation.
- */
-const compileReadme = series(readmeTemplate, addToReadme)
-
-module.exports = compileReadme
+const addToReadme = require('./addToReadme')
+const readmeTemplate = require('./readmeTemplate')
+const { series } = require('gulp')
+
+/**
+ * Generate the README.md file based off of the template, then append the generated documentation.
+ */
+const compileReadme = series(readmeTemplate, addToReadme)
+
+module.exports = compileReadme

package/functions/default.js

@@ -1,11 +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 = gulpConfig.nodeOnly ? series(dist) : series(dist, bundle)
-
-module.exports = defaultCmd
+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 = gulpConfig.nodeOnly ? series(dist) : series(dist, bundle)
+
+module.exports = defaultCmd

package/functions/dist.js

@@ -1,9 +1,9 @@
-const distFor = require('./distFor.js')
-
-/**
- * Simplified distribution tasks which will use arguments from distFor.
- * @returns {*}
- */
-const dist = () => distFor()
-
-module.exports = dist
+const distFor = require('./distFor.js')
+
+/**
+ * Simplified distribution tasks which will use arguments from distFor.
+ * @returns {*}
+ */
+const dist = () => distFor()
+
+module.exports = dist

package/functions/distFor.js

@@ -1,15 +1,15 @@
-const babel = require('gulp-babel')
-const { dest, src } = require('gulp')
-const gulpConfig = require('../gulp.config.js')
-
-/**
- * Build the distribution for a given source pattern.
- * @param {string|array} srcPath
- * @param {string} destPath
- * @returns {*}
- */
-const distFor = (srcPath = gulpConfig.srcSearch, destPath = gulpConfig.distPath) => src(srcPath)
-  .pipe(babel())
-  .pipe(dest(destPath))
-
-module.exports = distFor
+const babel = require('gulp-babel')
+const { dest, src } = require('gulp')
+const gulpConfig = require('../gulp.config.js')
+
+/**
+ * Build the distribution for a given source pattern.
+ * @param {string|array} srcPath
+ * @param {string} destPath
+ * @returns {*}
+ */
+const distFor = (srcPath = gulpConfig.srcSearch, destPath = gulpConfig.distPath) => src(srcPath)
+  .pipe(babel())
+  .pipe(dest(destPath))
+
+module.exports = distFor

package/functions/distLint.js

@@ -1,17 +1,17 @@
-const gulpConfig = require('../gulp.config.js')
-const { dest, src } = require('gulp')
-const standard = require('gulp-standard')
-
-/**
- * Applies Standard code style linting to distribution files.
- * @returns {*}
- */
-const distLint = () => src(gulpConfig.distSearch)
-  .pipe(standard({ fix: true }))
-  .pipe(standard.reporter('default', {
-    fix: true,
-    quiet: true
-  }))
-  .pipe(dest(gulpConfig.distPath))
-
-module.exports = distLint
+const gulpConfig = require('../gulp.config.js')
+const { dest, src } = require('gulp')
+const standard = require('gulp-standard')
+
+/**
+ * Applies Standard code style linting to distribution files.
+ * @returns {*}
+ */
+const distLint = () => src(gulpConfig.distSearch)
+  .pipe(standard({ fix: true }))
+  .pipe(standard.reporter('default', {
+    fix: true,
+    quiet: true
+  }))
+  .pipe(dest(gulpConfig.distPath))
+
+module.exports = distLint

package/functions/distMinify.js

@@ -1,15 +1,15 @@
-const { dest, src } = require('gulp')
-const gulpConfig = require('../gulp.config.js')
-const { default: uglify } = require('gulp-uglify-es')
-const rename = require('gulp-rename')
-
-/**
- * Creates minified versions of the dist files.
- * @returns {*}
- */
-const distMinify = () => src(gulpConfig.distSearch)
-  .pipe(uglify())
-  .pipe(rename({ extname: '.min.js' }))
-  .pipe(dest(gulpConfig.distPath))
-
-module.exports = distMinify
+const { dest, src } = require('gulp')
+const gulpConfig = require('../gulp.config.js')
+const { default: uglify } = require('gulp-uglify-es')
+const rename = require('gulp-rename')
+
+/**
+ * Creates minified versions of the dist files.
+ * @returns {*}
+ */
+const distMinify = () => src(gulpConfig.distSearch)
+  .pipe(uglify())
+  .pipe(rename({ extname: '.min.js' }))
+  .pipe(dest(gulpConfig.distPath))
+
+module.exports = distMinify

package/functions/readmeTemplate.js

@@ -1,13 +1,13 @@
-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.
- * @returns {*}
- */
-const readmeTemplate = () => src(gulpConfig.readmeTemplate)
-  .pipe(rename('README.md'))
-  .pipe(dest('.'))
-
-module.exports = readmeTemplate
+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.
+ * @returns {*}
+ */
+const readmeTemplate = () => src(gulpConfig.readmeTemplate)
+  .pipe(rename('README.md'))
+  .pipe(dest('.'))
+
+module.exports = readmeTemplate

package/functions/testFull.js

@@ -1,10 +1,10 @@
-const gulpConfig = require('../gulp.config.js');
-const { runCLI: jest } = require('jest')
-
-/**
- * Run all tests with jest.
- * @returns {Promise<*>}
- */
-const testFull = async () => await jest({}, gulpConfig.testPath)
-
-module.exports = testFull
+const gulpConfig = require('../gulp.config.js');
+const { runCLI: jest } = require('jest')
+
+/**
+ * Run all tests with jest.
+ * @returns {Promise<*>}
+ */
+const testFull = async () => await jest({}, gulpConfig.testPath)
+
+module.exports = testFull

package/functions/testHelpers.test.js

@@ -1,100 +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)
-  })
-})
+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/functions/testQuick.js

@@ -1,10 +1,10 @@
-const gulpConfig = require('../gulp.config.js')
-const { runCLI: jest } = require('jest')
-
-/**
- * Run the Jest tests for files which have been modified (based on git status).
- * @returns {Promise<*>}
- */
-const testQuick = async () => await jest({ onlyChanged: true }, gulpConfig.testPath)
-
-module.exports = testQuick
+const gulpConfig = require('../gulp.config.js')
+const { runCLI: jest } = require('jest')
+
+/**
+ * Run the Jest tests for files which have been modified (based on git status).
+ * @returns {Promise<*>}
+ */
+const testQuick = async () => await jest({ onlyChanged: true }, gulpConfig.testPath)
+
+module.exports = testQuick

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-build-tools",
-  "version": "1.2.2",
+  "version": "1.2.3",
   "description": "Standardised build process with gulp.",
   "main": "gulpfile.base.js",
   "scripts": {
@@ -33,25 +33,25 @@
     ]
   },
   "dependencies": {
-    "@babel/core": "^7.22.1",
-    "@babel/plugin-proposal-throw-expressions": "^7.18.6",
-    "@babel/preset-env": "^7.22.4",
-    "@babel/runtime-corejs3": "^7.22.3",
-    "babel-jest": "^29.5.0",
+    "@babel/core": "^7.22.15",
+    "@babel/plugin-proposal-throw-expressions": "^7.22.5",
+    "@babel/preset-env": "^7.22.15",
+    "@babel/runtime-corejs3": "^7.22.15",
+    "babel-jest": "^29.6.4",
     "browserify": "^17.0.0",
-    "core-js": "^3.30.2",
+    "core-js": "^3.32.1",
     "del": "^6.1.1",
     "fs": "^0.0.1-security",
-    "glob": "^10.2.6",
+    "glob": "^10.3.4",
     "gulp": "^4.0.2",
     "gulp-babel": "^8.0.0",
     "gulp-rename": "^2.0.0",
     "gulp-standard": "^14.0.0",
     "gulp-uglify-es": "^3.0.0",
-    "jest": "^29.5.0",
-    "jest-environment-jsdom": "^29.5.0",
+    "jest": "^29.6.4",
+    "jest-environment-jsdom": "^29.6.4",
     "jsdoc-to-markdown": "^8.0.0",
-    "regenerator-runtime": "^0.13.11",
+    "regenerator-runtime": "^0.14.0",
     "vinyl-source-stream": "^2.0.0"
   },
   "files": [