js-build-tools 1.2.2 → 2.1.0

package/functions/testQuick.js

@@ -1,10 +1,20 @@
-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 } = require('jest')
+
+/**
+ * Run the Jest tests for files which have been modified (based on git status).
+ * @function
+ * @memberOf module:js-build-tools
+ * @param {function} [done=null]
+ * @param {Array.<string>|string} [testPath='path/config/test/files']
+ * @returns {Promise<*>}
+ */
+const testQuick = (done = null, testPath = gulpConfig.get('testPath')) => {
+  if (!Array.isArray(testPath)) {
+    // The testPath must be an array of strings
+    testPath = [testPath]
+  }
+  return runCLI({ onlyChanged: true }, testPath)
+}
+
+module.exports = testQuick

package/functions/testQuick.test.js

@@ -0,0 +1,16 @@
+const { setUp } = require('./testHelpers')
+const gulpConfig = setUp.gulpConfig
+const { runCLI } = require('jest')
+const testQuick = require('./testQuick')
+
+jest.mock('jest', () => ({
+  'runCLI': jest.fn(() => Promise.resolve(true))
+}))
+
+describe('testQuick', () => {
+  test('runs the jest CLI with onlyChanged option', () => {
+    expect.assertions(1)
+    testQuick()
+    expect(runCLI).toHaveBeenCalledWith({ onlyChanged: true }, [gulpConfig.get('testPath')])
+  })
+})

package/functions/typeScript.js

@@ -0,0 +1,11 @@
+const tsFor = require('./partials/tsFor')
+
+/**
+ * Simplified typescript task using tsFor.
+ * @function
+ * @memberOf module:js-build-tools
+ * @returns {stream.Stream}
+ */
+const typeScript = () => tsFor()
+
+module.exports = typeScript

package/functions/typeScript.test.js

@@ -0,0 +1,10 @@
+const typeScript = require('./typeScript')
+const tsFor = require('./partials/tsFor')
+jest.mock('./partials/tsFor', () => jest.fn())
+
+describe('typeScript', () => {
+  test('calls tsFor with no parameters', () => {
+    typeScript()
+    expect(tsFor).toHaveBeenCalled()
+  })
+})

package/functions/watchFull.js

@@ -1,18 +1,12 @@
-const bundle = require('./bundle')
-const distFor = require('./distFor')
-const gulpConfig = require('../gulp.config.js')
-const { parallel, series, watch } = require('gulp')
-const testQuick = require('./testQuick')
+const { beginWatcher, runOnChange } = require('./partials')
 
 /**
  * Watch for changes and run the distribution for the changed files, then bundle and test the changed files.
- * @returns {*}
+ * @function
+ * @memberOf module:js-build-tools
+ * @returns {FSWatcher}
  */
-const watchFull = () => watch(gulpConfig.watchSearch)
-  .on('change', path => {
-    const pathRegex = new RegExp(`^${gulpConfig.srcPath}(.*\\/).+\\.js$`, 'i')
-    const distForPath = () => distFor(path, path.replace(pathRegex, `${gulpConfig.distPath}$1`))
-    return parallel(testQuick, series(distForPath, bundle))()
-  })
+const watchFull = () => beginWatcher()
+  .on('change', runOnChange)
 
 module.exports = watchFull

package/functions/watchFull.test.js

@@ -0,0 +1,40 @@
+const fs = require('fs')
+const setUp = require('./test-helpers/setUp')
+setUp.setDefaults('test-watch-full')
+const gulpConfig = setUp.gulpConfig
+const watchFull = require('./watchFull')
+const beginWatcher = require('./partials/beginWatcher')
+const runOnChange = require('./partials/runOnChange')
+
+jest.mock('./partials/beginWatcher', () => jest.fn(() => ({ on: (event, fn) => fn() })))
+jest.mock('./partials/runOnChange', () => jest.fn())
+
+const rawContents = 'const { beginWatcher, runOnChange } = require(\'./partials\')\n' +
+  '\n' +
+  '/**\n' +
+  ' * Watch for changes and run the distribution for the changed files, then bundle and test the changed files.\n' +
+  ' * @function\n' +
+  ' * @memberOf module:js-build-tools\n' +
+  ' * @returns {FSWatcher}\n' +
+  ' */\n' +
+  'const watchFull = () => beginWatcher()\n' +
+  '  .on(\'change\', runOnChange)\n' +
+  '\n' +
+  'module.exports = watchFull\n'
+
+beforeEach(setUp.beforeEach)
+
+afterEach(setUp.afterEach)
+
+describe('watchFull', () => {
+  test('should call beginWatcher and runOnChange for change event', () => {
+    const srcPath = gulpConfig.get('srcPath')
+    gulpConfig.set('watchSearch', `${srcPath}/*.js`)
+    const srcFile = `${srcPath}/watchFull.js`
+    fs.writeFileSync(srcFile, rawContents)
+    expect.assertions(2)
+    watchFull()
+    expect(beginWatcher).toHaveBeenCalled()
+    expect(runOnChange).toHaveBeenCalled()
+  })
+})

package/functions/watchTest.js

@@ -1,11 +1,13 @@
 const gulpConfig = require('../gulp.config.js')
-const { series, watch } = require('gulp')
+const { watch } = require('gulp')
 const testQuick = require('./testQuick')
 
 /**
  * Watch for changes and run the tests.
+ * @function
+ * @memberOf module:js-build-tools
  * @returns {*}
  */
-const watchTest = () => watch(gulpConfig.watchSearch, { ignoreInitial: false }, series(testQuick))
+const watchTest = () => watch(gulpConfig.get('watchSearch'), { ignoreInitial: false }, testQuick)
 
 module.exports = watchTest

package/functions/watchTest.test.js

@@ -0,0 +1,48 @@
+const setUp = require('./test-helpers/setUp')
+setUp.setDefaults('test-watch-test')
+const gulpConfig = setUp.gulpConfig
+gulpConfig.set('watchSearch', 'test-begin-watcher/*.js')
+const watchTest = require('./watchTest')
+const { EventEmitter } = require('node:events')
+const fs = require('fs')
+const testQuick = require('./testQuick')
+
+jest.mock('./testQuick', () => jest.fn(() => Promise.resolve(true)))
+
+const rawContents = 'const gulpConfig = require(\'../gulp.config.js\')\n' +
+  'const { watch } = require(\'gulp\')\n' +
+  'const testQuick = require(\'./testQuick\')\n' +
+  '\n' +
+  '/**\n' +
+  ' * Watch for changes and run the tests.\n' +
+  ' * @function\n' +
+  ' * @memberOf module:js-build-tools\n' +
+  ' * @returns {*}\n' +
+  ' */\n' +
+  'const watchTest = () => watch(gulpConfig.get(\'watchSearch\'), { ignoreInitial: false }, testQuick)\n' +
+  '\n' +
+  'module.exports = watchTest\n'
+
+const filePath = gulpConfig.get('srcPath') + '/watchTest.js'
+
+beforeEach(() => setUp.beforeEach()
+  .then(
+    () => fs.writeFileSync(filePath, rawContents)
+  )
+)
+
+afterEach(setUp.afterEach)
+
+describe('watchTest', () => {
+  test('returns instance of EventEmitter / FSWatcher and calls testQuick on change', done => {
+    expect.assertions(2)
+    const fsWatcher = watchTest()
+    expect(fsWatcher).toBeInstanceOf(EventEmitter)
+    fsWatcher.emit('change')
+    setTimeout(() => {
+      expect(testQuick).toHaveBeenCalled()
+      done()
+    }, 500)
+    fsWatcher.close()
+  })
+})

package/gulp.config.js

@@ -1,30 +1,175 @@
-const defaultConfig = (config, path, defaultValue) => {
+/**
+ * Modify these configurations to match your project specifications.
+ * @file
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 2.0.0
+ * @module gulpConfig
+ * @memberOf module:js-build-tools
+ */
+
+/**
+ * Retrieve a value from an object with the path (key), return a given default if the key is not found.
+ * @memberOf module:gulpConfig
+ * @param {Object<string, *>} [config=[]]
+ * @param {string|null} [path=null]
+ * @param {*} [defaultValue=null]
+ * @returns {*|null}
+ */
+const defaultConfig = (config = {}, path = null, defaultValue = null) => {
+  if (!path) {
+    return config
+  }
   if (typeof config[path] === 'undefined') {
     return defaultValue
   }
   return config[path]
 }
-let parentConfig = {}
+
+/**
+ * A setting that may be an array of strings or a string only.
+ * @typedef {Array<string>|string} module:gulpConfig~ArrayableSetting
+ */
+
+/**
+ * A setting that may be true or false.
+ * @typedef {boolean} module:gulpConfig~BooleanSetting
+ */
+
+/**
+ * A setting that may be flag 'false' or provide a StringSetting
+ * @typedef {false|StringSetting} module:gulpConfig~FlagStringSetting
+ */
+
+/**
+ * An object of boolean settings used as flags.
+ * @typedef {Object<string, BooleanSetting>} module:gulpConfig~FlagsSetting
+ */
+
+/**
+ * Configure cli options for running Jest.
+ * @typedef {FlagsSetting} module:gulpConfig~JestTestFlags
+ * @property {BooleanSetting} clearCache
+ * @property {BooleanSetting} debug
+ * @property {BooleanSetting} ignoreProjects:
+ * @property {BooleanSetting} json
+ * @property {BooleanSetting} selectProjects
+ * @property {BooleanSetting} showConfig
+ * @property {BooleanSetting} useStderr
+ * @property {BooleanSetting} watch
+ * @property {BooleanSetting} watchAll
+ */
+
+/**
+ * A setting that may only be a string.
+ * @typedef {string} module:gulpConfig~StringSetting
+ */
+
+/**
+ * Any single configuration option is a Setting.
+ * @typedef {ArrayableSetting|BooleanSetting|FlagsSetting|StringSetting} Setting
+ */
+
+/**
+ * A set of Configurations options defined by Settings.
+ * @typedef {Object<string, Setting>} module:gulpConfig~Configurations
+ * @property {StringSetting} browserName
+ * @property {StringSetting} browserPath
+ * @property {StringSetting} distMain
+ * @property {StringSetting} distPath
+ * @property {ArrayableSetting} distSearch
+ * @property {BooleanSetting} nodeOnly
+ * @property {StringSetting} readmeTemplate
+ * @property {ArrayableSetting} readmeOptions
+ * @property {StringSetting} readmeFile
+ * @property {StringSetting} readmePath
+ * @property {ArrayableSetting} readmeSearch
+ * @property {StringSetting} rootPath
+ * @property {StringSetting} srcPath
+ * @property {ArrayableSetting} srcSearch
+ * @property {JestTestFlags} testOptions
+ * @property {ArrayableSetting} testPath
+ * @property {FlagStringSetting} useTsConfig
+ * @property {ArrayableSetting} watchSearch
+ */
+
+/**
+ * All the available configuration setting options for running the build.
+ * @memberOf module:gulpConfig` `
+ * @type {Configurations}
+ */
+let gulpConfigurations = {}
 try {
-  parentConfig = require('../../build-tools.config.js')
+  gulpConfigurations = require('../../build-tools.config.js')
 } catch (isUndefined) {
   try {
-    parentConfig = require('./build-tools.config.js')
-    console.info('Missing main project config, using default path')
+    // Missing main project config, using default path
+    gulpConfigurations = require('./build-tools.config.js')
   } catch (stillUndefined) {
     console.warn('Missing config path, ensure you have a build-tools.config.js file in you project root')
   }
 }
+
+const setDefaults = {
+  browserName: 'default',
+  browserPath: 'browser',
+  distMain: 'dist/main',
+  distPath: 'dist',
+  distSearch: 'dist/**/*.js',
+  nodeOnly: false,
+  readmeTemplate: 'MAIN.md',
+  readmeOptions: 'utf8',
+  readmeFile: 'README.md',
+  readmePath: './',
+  readmeSearch: 'src/**/!(*.test).js',
+  rootPath: './',
+  srcPath: 'src',
+  srcSearch: 'src/**/!(*.test).js',
+  testOptions: {
+    clearCache: false,
+    debug: false,
+    ignoreProjects: false,
+    json: false,
+    selectProjects: false,
+    showConfig: false,
+    useStderr: false,
+    watch: false,
+    watchAll: false,
+  },
+  testPath: ['src'],
+  tsSearch: 'src/**/*.ts',
+  useTsConfig: false,
+  watchSearch: 'src/**/*.js'
+}
+
+Object.keys(setDefaults).forEach(parentKey => {
+  gulpConfigurations[parentKey] = defaultConfig(gulpConfigurations, parentKey, setDefaults[parentKey])
+})
+
+/**
+ * Retrieve a value from teh configurations, default may be returned.
+ * @function
+ * @memberOf module:gulpConfig
+ * @param {string|null} path
+ * @param {*} defaultValue
+ * @returns {*|null}
+ */
+const get = (path = null, defaultValue = null) => defaultConfig(gulpConfigurations, path, defaultValue)
+
+/**
+ * Specify a value for the configurations to use.
+ * @function
+ * @memberOf module:gulpConfig
+ * @param path
+ * @param value
+ * @returns {*}
+ */
+const set = (path, value) => {
+  gulpConfigurations[path] = value
+  return value
+}
+
 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'),
-  testPath: defaultConfig(parentConfig, 'testPath', ['src']),
-  watchSearch: defaultConfig(parentConfig, 'watchSearch', 'src/**/*.js'),
+  defaultConfig,
+  get,
+  set
 }

package/gulpfile.base.js

@@ -1,3 +1,12 @@
+/**
+ * Export these functions to your own project in order to customize your build pipeline.
+ * @file
+ * @author Joshua Heagle <joshuaheagle@gmail.com>
+ * @version 2.0.0
+ * @module js-build-tools
+ */
+
+const gulpConfig = require('./gulp.config.js')
 const build = require('./functions/build.js')
 const compileReadme = require('./functions/compileReadme.js')
 const defaultCmd = require('./functions/default.js')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-build-tools",
-  "version": "1.2.2",
+  "version": "2.1.0",
   "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": [

package/dist/addToReadme.js

@@ -1,22 +0,0 @@
-'use strict'
-
-const fs = require('fs')
-const gulpConfig = require('../gulp.config.js')
-const jsdoc2md = require('jsdoc-to-markdown')
-const {
-  globSync
-} = require('glob')
-
-/**
- * Appends all the jsdoc comments to the readme file. Assumes empty or templated file.
- * @returns {string|Uint8Array}
- */
-const addToReadme = done => {
-  const files = globSync(gulpConfig.srcSearch)
-  const readme = jsdoc2md.renderSync({
-    files: files
-  })
-  fs.appendFileSync('README.md', readme, 'utf8')
-  done()
-}
-module.exports = addToReadme

package/dist/addToReadme.min.js

@@ -1 +0,0 @@
-"use strict";const fs=require("fs"),gulpConfig=require("../gulp.config.js"),jsdoc2md=require("jsdoc-to-markdown"),{globSync:globSync}=require("glob"),addToReadme=e=>{const o=globSync(gulpConfig.srcSearch),d=jsdoc2md.renderSync({files:o});fs.appendFileSync("README.md",d,"utf8"),e()};module.exports=addToReadme;

package/dist/clean.js

@@ -1,11 +0,0 @@
-'use strict'
-
-const del = require('del')
-const gulpConfig = require('../gulp.config.js')
-
-/**
- * Deletes all the distribution and browser files (used before create a new build).
- * @returns {Promise<string[]> | *}
- */
-const clean = () => del([gulpConfig.distPath, gulpConfig.browserPath])
-module.exports = clean

package/dist/clean.min.js

@@ -1 +0,0 @@
-"use strict";const del=require("del"),gulpConfig=require("../gulp.config.js"),clean=()=>del([gulpConfig.distPath,gulpConfig.browserPath]);module.exports=clean;

package/dist/distFor.js

@@ -1,21 +0,0 @@
-'use strict'
-
-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 = function () {
-  const srcPath = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : gulpConfig.srcSearch
-  const destPath = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : gulpConfig.distPath
-  return src(srcPath).pipe(babel()).pipe(dest(destPath))
-}
-module.exports = distFor

package/dist/distFor.min.js

@@ -1 +0,0 @@
-"use strict";const babel=require("gulp-babel"),{dest:dest,src:src}=require("gulp"),gulpConfig=require("../gulp.config.js"),distFor=function(){let e=arguments.length>0&&void 0!==arguments[0]?arguments[0]:gulpConfig.srcSearch,r=arguments.length>1&&void 0!==arguments[1]?arguments[1]:gulpConfig.distPath;return src(e).pipe(babel()).pipe(dest(r))};module.exports=distFor;

package/dist/readmeTemplate.js

@@ -1,15 +0,0 @@
-'use strict'
-
-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/dist/readmeTemplate.min.js

@@ -1 +0,0 @@
-"use strict";const{dest:dest,src:src}=require("gulp"),gulpConfig=require("../gulp.config.js"),rename=require("gulp-rename"),readmeTemplate=()=>src(gulpConfig.readmeTemplate).pipe(rename("README.md")).pipe(dest("."));module.exports=readmeTemplate;

package/functions/addToReadme.js

@@ -1,17 +0,0 @@
-const fs = require('fs')
-const gulpConfig = require('../gulp.config.js')
-const jsdoc2md = require('jsdoc-to-markdown')
-const { globSync } = require('glob')
-
-/**
- * Appends all the jsdoc comments to the readme file. Assumes empty or templated file.
- * @returns {string|Uint8Array}
- */
-const addToReadme = done => {
-  const files = globSync(gulpConfig.srcSearch)
-  const readme = jsdoc2md.renderSync({ files: files })
-  fs.appendFileSync('README.md', readme, 'utf8')
-  done()
-}
-
-module.exports = addToReadme

package/functions/clean.js

@@ -1,10 +0,0 @@
-const del = require('del')
-const gulpConfig = require('../gulp.config.js')
-
-/**
- * Deletes all the distribution and browser files (used before create a new build).
- * @returns {Promise<string[]> | *}
- */
-const clean = () => del([gulpConfig.distPath, gulpConfig.browserPath])
-
-module.exports = clean

package/functions/distFor.js

@@ -1,15 +0,0 @@
-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/readmeTemplate.js

@@ -1,13 +0,0 @@
-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