js-build-tools 1.2.2 → 2.1.0

package/functions/bundleLint.test.js

@@ -0,0 +1,61 @@
+const fs = require('fs')
+const setUp = require('./test-helpers/setUp')
+setUp.setDefaults('test-bundle-lint')
+const gulpConfig = setUp.gulpConfig
+const bundleLint = require('./bundleLint')
+const { countMatches } = require('./testHelpers')
+
+const lintableContents = 'const gulpConfig = require("../gulp.config.js");\n' +
+  'const { dest, src } = require("gulp");\n' +
+  'const standard = require("gulp-standard");\n' +
+  '\n' +
+  '/**\n' +
+  ' * Applies Standard code style linting to distribution files.\n' +
+  ' * @returns {*}\n' +
+  ' */\n' +
+  'const bundleLint = () => src(`${gulpConfig.get(\"browserPath\")}/${gulpConfig.get(\"browserName\")}.js`)\n' +
+  '  .pipe(standard({ fix: true }))\n' +
+  '  .pipe(standard.reporter("default", {\n' +
+  '    fix: true,\n' +
+  '    quiet: true\n' +
+  '  }))\n' +
+  '  .pipe(dest(gulpConfig.get("browserPath")));\n' +
+  '\n' +
+  'module.exports = bundleLint;'
+
+beforeEach(
+  () => setUp.beforeEach()
+    .then(
+      async () => {
+        const browserPath = gulpConfig.get('browserPath')
+        const browserName = gulpConfig.get('browserName')
+        await fs.mkdirSync(browserPath)
+        return fs.writeFileSync(`${browserPath}/${browserName}.js`, lintableContents)
+      }
+    )
+)
+
+afterEach(setUp.afterEach)
+
+describe('bundleLint', () => {
+  test('copies the src directory and babelifies it into the dist directory', done => {
+    const browserPath = gulpConfig.get('browserPath')
+    const browserName = gulpConfig.get('browserName')
+    const fullPath = `${browserPath}/${browserName}.js`
+    const oldContents = fs.readFileSync(fullPath).toString()
+    expect.assertions(4)
+    expect(countMatches(oldContents, '"')).toEqual(14)
+    expect(countMatches(oldContents, ';')).toEqual(5)
+    bundleLint()
+      .on('finish', () => {
+        const lintedContents = fs.readFileSync(fullPath).toString()
+        expect(countMatches(lintedContents, '"')).toEqual(0)
+        expect(countMatches(lintedContents, ';')).toEqual(0)
+        done()
+      })
+      .on('error', error => {
+        console.error('Encountered error', error)
+        done()
+      })
+  }, 10000)
+})

package/functions/bundleMinify.js

@@ -1,15 +1,12 @@
-const { dest, src } = require('gulp')
-const gulpConfig = require('../gulp.config.js')
-const { default: uglify } = require('gulp-uglify-es')
-const rename = require('gulp-rename')
-
-/**
- * Creates the minified bundle file.
- * @returns {*}
- */
-const bundleMinify = () => src(`${gulpConfig.browserPath}/${gulpConfig.browserName}.js`)
-  .pipe(uglify())
-  .pipe(rename({ extname: '.min.js' }))
-  .pipe(dest(gulpConfig.browserPath))
-
-module.exports = bundleMinify
+const gulpConfig = require('../gulp.config.js')
+const minifyFor = require('./partials/minifyFor')
+
+/**
+ * Creates the minified bundle file.
+ * @function
+ * @memberOf module:js-build-tools
+ * @returns {*}
+ */
+const bundleMinify = () => minifyFor(`${gulpConfig.get('browserPath')}/${gulpConfig.get('browserName')}.js`, gulpConfig.get('browserPath'))
+
+module.exports = bundleMinify

package/functions/bundleMinify.test.js

@@ -0,0 +1,14 @@
+const { setUp } = require('./testHelpers')
+const gulpConfig = setUp.gulpConfig
+const bundleMinify = require('./bundleMinify')
+const minifyFor = require('./partials/minifyFor')
+
+jest.mock('./partials/minifyFor', () => jest.fn(() => Promise.resolve(true)))
+
+describe('bundleMinify', () => {
+  test('calls minifyFor with configurations', () => {
+    expect.assertions(1)
+    bundleMinify()
+    expect(minifyFor).toHaveBeenCalledWith(`${gulpConfig.get('browserPath')}/${gulpConfig.get('browserName')}.js`, gulpConfig.get('browserPath'))
+  })
+})

package/functions/compileReadme.js

@@ -1,10 +1,11 @@
-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, readmeTemplate } = require('./partials')
+const { series } = require('gulp')
+
+/**
+ * Generate the README.md file based off of the template, then append the generated documentation.
+ * @memberOf module:js-build-tools
+ * @returns {stream.Stream}
+ */
+const compileReadme = series(readmeTemplate, addToReadme)
+
+module.exports = compileReadme

package/functions/compileReadme.test.js

@@ -0,0 +1,18 @@
+const compileReadme = require('./compileReadme')
+const { addToReadme, readmeTemplate} = require('./partials')
+
+const genericFunction = () => Promise.resolve(true)
+jest.mock('./partials/addToReadme', () => jest.fn(genericFunction))
+jest.mock('./partials/readmeTemplate', () => jest.fn(genericFunction))
+
+describe('compileReadme', () => {
+  test('calls readmeTemplate and addToReadme', done => {
+    expect.assertions(2)
+    compileReadme()
+    setTimeout(() => {
+      expect(readmeTemplate).toHaveBeenCalled()
+      expect(addToReadme).toHaveBeenCalled()
+      done()
+    }, 500)
+  })
+})

package/functions/default.js

@@ -1,11 +1,14 @@
-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 dist = require('./dist')
+const bundle = require('./bundle')
+const gulpConfig = require('../gulp.config')
+const { series } = require('gulp')
+
+/**
+ * Recommended as the default task, runs the simple dist and bundle tasks.
+ * @memberOf module:js-build-tools
+ * @param {function} [done=null]
+ * @returns {stream.Stream}
+ */
+const defaultCmd = (done = null) => gulpConfig.get('nodeOnly') ? series(dist)(done) : series(dist, bundle)(done)
+
+module.exports = defaultCmd

package/functions/default.test.js

@@ -0,0 +1,32 @@
+const { setUp } = require('./testHelpers')
+const gulpConfig = setUp.gulpConfig
+const bundle = require('./bundle')
+const dist = require('./dist')
+const defaultCmd = require('./default')
+
+const genericFunction = () => Promise.resolve(true)
+jest.mock('./bundle', () => jest.fn(genericFunction))
+jest.mock('./dist', () => jest.fn(genericFunction))
+
+describe('distMinify', () => {
+  test('calls dist for nodeOnly true', done => {
+    gulpConfig.set('nodeOnly', true)
+    expect.assertions(1)
+    defaultCmd()
+    setTimeout(() => {
+      expect(dist).toHaveBeenCalled()
+      done()
+    }, 500)
+  })
+
+  test('calls dist and bundle for nodeOnly false', done => {
+    gulpConfig.set('nodeOnly', false)
+    expect.assertions(2)
+    defaultCmd()
+    setTimeout(() => {
+      expect(dist).toHaveBeenCalled()
+      expect(bundle).toHaveBeenCalled()
+      done()
+    }, 500)
+  })
+})

package/functions/dist.js

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

package/functions/dist.test.js

@@ -0,0 +1,43 @@
+const fs = require('fs')
+const setUp = require('./test-helpers/setUp')
+setUp.setDefaults('test-dist')
+const gulpConfig = setUp.gulpConfig
+const dist = require('./dist')
+
+const rawContents = 'const distFor = require(\'./distFor.js\')\n' +
+  '\n' +
+  '/**\n' +
+  ' * Simplified distribution tasks which will use arguments from distFor.\n' +
+  ' * @returns {*}\n' +
+  ' */\n' +
+  'const dist = () => distFor()\n' +
+  '\n' +
+  'module.exports = dist\n'
+
+beforeEach(
+  () => setUp.beforeEach()
+    .then(
+      async () => {
+        const srcPath = gulpConfig.get('srcPath')
+        return fs.writeFileSync(`${srcPath}/dist.js`, rawContents)
+      }
+    )
+)
+
+afterEach(setUp.afterEach)
+
+describe('dist', () => {
+  test('uses the configured paths', done => {
+    const distPath = gulpConfig.get('distPath')
+    expect.assertions(1)
+    dist()
+      .on('finish', () => {
+        expect(fs.existsSync(distPath)).toBeTruthy()
+        done()
+      })
+      .on('error', error => {
+        console.error('Encountered error', error)
+        done()
+      })
+  }, 10000)
+})

package/functions/distLint.js

@@ -1,17 +1,19 @@
-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.
+ * @function
+ * @memberOf module:js-build-tools
+ * @returns {*}
+ */
+const distLint = () => src(gulpConfig.get('distSearch'))
+  .pipe(standard({ fix: true }))
+  .pipe(standard.reporter('default', {
+    fix: true,
+    quiet: true
+  }))
+  .pipe(dest(gulpConfig.get('distPath')))
+
+module.exports = distLint

package/functions/distLint.test.js

@@ -0,0 +1,58 @@
+const fs = require('fs')
+const setUp = require('./test-helpers/setUp')
+setUp.setDefaults('test-dist-lint')
+const gulpConfig = setUp.gulpConfig
+const distLint = require('./distLint')
+const { countMatches } = require('./testHelpers')
+
+const lintableContents = 'const gulpConfig = require("../gulp.config.js");\n' +
+  'const { dest, src } = require("gulp");\n' +
+  'const standard = require("gulp-standard");\n' +
+  '\n' +
+  '/**\n' +
+  ' * Applies Standard code style linting to distribution files.\n' +
+  ' * @returns {*}\n' +
+  ' */\n' +
+  'const distLint = () => src(gulpConfig.get("distSearch"))\n' +
+  '  .pipe(standard({ fix: true }))\n' +
+  '  .pipe(standard.reporter("default", {\n' +
+  '    fix: true,\n' +
+  '    quiet: true\n' +
+  '  }))\n' +
+  '  .pipe(dest(gulpConfig.get("distPath")));\n' +
+  '\n' +
+  'module.exports = distLint;'
+
+beforeEach(
+  () => setUp.beforeEach()
+    .then(
+      async () => {
+        const distPath = gulpConfig.get('distPath')
+        await fs.mkdirSync(distPath)
+        return fs.writeFileSync(`${distPath}/distLint.js`, lintableContents)
+      }
+    )
+)
+
+afterEach(setUp.afterEach)
+
+describe('distLint', () => {
+  test('copies the src directory and babelifies it into the dist directory', done => {
+    const distPath = gulpConfig.get('distPath')
+    const oldContents = fs.readFileSync(`${distPath}/distLint.js`).toString()
+    expect.assertions(4)
+    expect(countMatches(oldContents, '"')).toEqual(12)
+    expect(countMatches(oldContents, ';')).toEqual(5)
+    distLint()
+      .on('finish', () => {
+        const lintedContents = fs.readFileSync(`${distPath}/distLint.js`).toString()
+        expect(countMatches(lintedContents, '"')).toEqual(0)
+        expect(countMatches(lintedContents, ';')).toEqual(0)
+        done()
+      })
+      .on('error', error => {
+        console.error('Encountered error', error)
+        done()
+      })
+  }, 10000)
+})

package/functions/distMinify.js

@@ -1,15 +1,12 @@
-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 gulpConfig = require('../gulp.config.js')
+const minifyFor = require('./partials/minifyFor')
+
+/**
+ * Creates minified versions of the dist files.
+ * @function
+ * @memberOf module:js-build-tools
+ * @returns {*}
+ */
+const distMinify = () => minifyFor(gulpConfig.get('distSearch'), gulpConfig.get('distPath'))
+
+module.exports = distMinify

package/functions/distMinify.test.js

@@ -0,0 +1,14 @@
+const { setUp } = require('./testHelpers')
+const gulpConfig = setUp.gulpConfig
+const distMinify = require('./distMinify')
+const minifyFor = require('./partials/minifyFor')
+
+jest.mock('./partials/minifyFor', () => jest.fn(() => Promise.resolve(true)))
+
+describe('distMinify', () => {
+  test('calls minifyFor with configurations', () => {
+    expect.assertions(1)
+    distMinify()
+    expect(minifyFor).toHaveBeenCalledWith(gulpConfig.get('distSearch'), gulpConfig.get('distPath'))
+  })
+})

package/functions/partials/addToReadme.js

@@ -0,0 +1,20 @@
+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.
+ * @function
+ * @memberOf module:partials
+ * @param {function|null} [done=null]
+ * @returns {string|Uint8Array}
+ */
+const addToReadme = (done = null) => {
+  const files = globSync(gulpConfig.get('readmeSearch'))
+  const readme = jsdoc2md.renderSync({ files: files })
+  fs.appendFileSync(gulpConfig.get('readmePath') + gulpConfig.get('readmeFile'), readme, gulpConfig.get('readmeOptions'))
+  return done && done()
+}
+
+module.exports = addToReadme

package/functions/partials/addToReadme.test.js

@@ -0,0 +1,28 @@
+const fs = require('fs')
+const setUp = require('../test-helpers/setUp')
+setUp.setDefaults('test-add-to-readme')
+const gulpConfig = setUp.gulpConfig
+gulpConfig.set('srcSearch', 'test-temp/src/addToReadme.js')
+const addToReadme = require('./addToReadme')
+
+const rawContents = 'export function sayHello(name: string) {\n' +
+  '  return `Hello from ${name}`;\n' +
+  '}'
+
+beforeEach(() => setUp.beforeEach()
+  .then(() => fs.writeFileSync(gulpConfig.get('srcPath') + '/addToReadme.js', rawContents)))
+
+afterEach(setUp.afterEach)
+
+describe('addToReadme', () => {
+  test('generates the documentation', () => {
+    const readmeFilePath = gulpConfig.get('readmePath') + gulpConfig.get('readmeFile')
+    expect.assertions(2)
+    addToReadme(async () => {
+      await expect(fs.existsSync(readmeFilePath)).toBeTruthy()
+      const readme = await fs.readFileSync(readmeFilePath)
+      // At least the documentation will have the addToReadme documentation
+      await expect(readme.includes('addToReadme')).toBeTruthy()
+    })
+  })
+})

package/functions/partials/beginWatcher.js

@@ -0,0 +1,12 @@
+const gulpConfig = require('../../gulp.config.js')
+const { watch } = require('gulp')
+
+/**
+ * Create a chokidar instance which watches and triggers change when the globed files are modified.
+ * @function
+ * @memberOf module:partials
+ * @returns {FSWatcher}
+ */
+const beginWatcher = () => watch(gulpConfig.get('watchSearch'))
+
+module.exports = beginWatcher

package/functions/partials/beginWatcher.test.js

@@ -0,0 +1,18 @@
+const setUp = require('../test-helpers/setUp')
+setUp.setDefaults('test-begin-watcher')
+const gulpConfig = setUp.gulpConfig
+const beginWatcher = require('./beginWatcher')
+const { EventEmitter } = require('node:events')
+
+beforeEach(setUp.beforeEach)
+
+afterEach(setUp.afterEach)
+
+describe('beginWatcher', () => {
+  test('returns instance of EventEmitter / FSWatcher', () => {
+    gulpConfig.set('watchSearch', 'test-begin-watcher/*.js')
+    const fsWatcher = beginWatcher()
+    expect(fsWatcher).toBeInstanceOf(EventEmitter)
+    fsWatcher.close()
+  })
+})

package/functions/partials/clean.js

@@ -0,0 +1,14 @@
+const del = require('del')
+const gulpConfig = require('../../gulp.config.js')
+
+/**
+ * Deletes all the distribution and browser files (used before create a new build).
+ * @function
+ * @memberOf module:partials
+ * @param {function} [done=null]
+ * @param {string[]} [paths=['dist/config/path', 'browser/config/path']]
+ * @returns {Promise<string[]> | *}
+ */
+const clean = (done = null, paths = [gulpConfig.get('distPath'), gulpConfig.get('browserPath')]) => del(paths).then(() => done && done())
+
+module.exports = clean

package/functions/partials/clean.test.js

@@ -0,0 +1,20 @@
+const fs = require('fs')
+const setUp = require('../test-helpers/setUp')
+setUp.setDefaults('test-clean')
+const gulpConfig = setUp.gulpConfig
+const clean = require('./clean')
+
+beforeEach(setUp.beforeEach)
+
+afterEach(setUp.afterEach)
+
+describe('clean', () => {
+  test('removes all contents of directories specified', async () => {
+    expect.assertions(2)
+    const srcPath = gulpConfig.get('srcPath')
+    expect(fs.readdirSync(srcPath)).toBeTruthy()
+    // Run the clean script to empty the directories
+    await clean(null, [srcPath])
+    expect(fs.existsSync(srcPath)).toBeFalsy()
+  })
+})

package/functions/partials/distFor.js

@@ -0,0 +1,18 @@
+const babel = require('gulp-babel')
+const { dest, src } = require('gulp')
+const distForSrc = require('./distForSrc')
+const gulpConfig = require('../../gulp.config.js')
+
+/**
+ * Build the distribution for a given source pattern.
+ * @function
+ * @memberOf module:partials
+ * @param {string|array} [srcPath='src/config/path/dist/for']
+ * @param {string} [destPath='dist/config/path']
+ * @returns {*}
+ */
+const distFor = (srcPath = distForSrc(), destPath = gulpConfig.get('distPath')) => src(srcPath)
+  .pipe(babel())
+  .pipe(dest(destPath))
+
+module.exports = distFor