js-build-tools 1.2.1 → 1.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. package/README.md +353 -353
  2. package/dist/addToReadme.js +22 -21
  3. package/dist/addToReadme.min.js +1 -1
  4. package/dist/build.js +23 -22
  5. package/dist/build.min.js +1 -1
  6. package/dist/bundle.js +15 -16
  7. package/dist/bundle.min.js +1 -1
  8. package/dist/bundleLint.js +20 -22
  9. package/dist/bundleLint.min.js +1 -1
  10. package/dist/bundleMinify.js +20 -21
  11. package/dist/bundleMinify.min.js +1 -1
  12. package/dist/clean.js +8 -10
  13. package/dist/clean.min.js +1 -1
  14. package/dist/compileReadme.js +13 -12
  15. package/dist/compileReadme.min.js +1 -1
  16. package/dist/default.js +14 -13
  17. package/dist/default.min.js +1 -1
  18. package/dist/dist.js +10 -12
  19. package/dist/dist.min.js +1 -1
  20. package/dist/distFor.js +21 -20
  21. package/dist/distFor.min.js +1 -1
  22. package/dist/distLint.js +20 -21
  23. package/dist/distLint.min.js +1 -1
  24. package/dist/distMinify.js +20 -20
  25. package/dist/distMinify.min.js +1 -1
  26. package/dist/readmeTemplate.js +15 -16
  27. package/dist/readmeTemplate.min.js +1 -1
  28. package/dist/testFull.js +13 -56
  29. package/dist/testFull.min.js +1 -1
  30. package/dist/testHelpers.js +175 -176
  31. package/dist/testHelpers.min.js +1 -1
  32. package/dist/testQuick.js +15 -58
  33. package/dist/testQuick.min.js +1 -1
  34. package/dist/watchFull.js +20 -27
  35. package/dist/watchFull.min.js +1 -1
  36. package/dist/watchTest.js +14 -15
  37. package/dist/watchTest.min.js +1 -1
  38. package/functions/addToReadme.js +17 -17
  39. package/functions/build.js +25 -25
  40. package/functions/bundle.js +15 -15
  41. package/functions/bundleLint.js +17 -17
  42. package/functions/bundleMinify.js +15 -15
  43. package/functions/compileReadme.js +10 -10
  44. package/functions/default.js +11 -11
  45. package/functions/dist.js +9 -9
  46. package/functions/distFor.js +15 -15
  47. package/functions/distLint.js +17 -17
  48. package/functions/distMinify.js +15 -15
  49. package/functions/readmeTemplate.js +13 -13
  50. package/functions/testFull.js +10 -10
  51. package/functions/testHelpers.test.js +100 -100
  52. package/functions/testQuick.js +10 -10
  53. package/package.json +11 -11
package/dist/watchFull.js CHANGED
@@ -1,30 +1,23 @@
1
- 'use strict'
2
-
3
- require('core-js/modules/es.regexp.constructor.js')
4
- require('core-js/modules/es.regexp.exec.js')
5
- require('core-js/modules/es.regexp.sticky.js')
6
- require('core-js/modules/es.regexp.to-string.js')
7
- require('core-js/modules/es.string.replace.js')
8
- var bundle = require('./bundle')
9
- var distFor = require('./distFor')
10
- var gulpConfig = require('../gulp.config.js')
11
- var _require = require('gulp')
12
- var parallel = _require.parallel
13
- var series = _require.series
14
- var watch = _require.watch
15
- var testQuick = require('./testQuick')
16
-
1
+ 'use strict'
2
+
3
+ require('core-js/modules/es.string.replace.js')
4
+ const bundle = require('./bundle')
5
+ const distFor = require('./distFor')
6
+ const gulpConfig = require('../gulp.config.js')
7
+ const {
8
+ parallel,
9
+ series,
10
+ watch
11
+ } = require('gulp')
12
+ const testQuick = require('./testQuick')
13
+
17
14
  /**
18
15
  * Watch for changes and run the distribution for the changed files, then bundle and test the changed files.
19
16
  * @returns {*}
20
- */
21
- var watchFull = function watchFull () {
22
- return watch(gulpConfig.watchSearch).on('change', function (path) {
23
- var pathRegex = new RegExp('^'.concat(gulpConfig.srcPath, '(.*\\/).+\\.js$'), 'i')
24
- var distForPath = function distForPath () {
25
- return distFor(path, path.replace(pathRegex, ''.concat(gulpConfig.distPath, '$1')))
26
- }
27
- return parallel(testQuick, series(distForPath, bundle))()
28
- })
29
- }
30
- module.exports = watchFull
17
+ */
18
+ const watchFull = () => watch(gulpConfig.watchSearch).on('change', path => {
19
+ const pathRegex = new RegExp('^'.concat(gulpConfig.srcPath, '(.*\\/).+\\.js$'), 'i')
20
+ const distForPath = () => distFor(path, path.replace(pathRegex, ''.concat(gulpConfig.distPath, '$1')))
21
+ return parallel(testQuick, series(distForPath, bundle))()
22
+ })
23
+ module.exports = watchFull
@@ -1 +1 @@
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;
1
+ "use strict";require("core-js/modules/es.string.replace.js");const bundle=require("./bundle"),distFor=require("./distFor"),gulpConfig=require("../gulp.config.js"),{parallel:parallel,series:series,watch:watch}=require("gulp"),testQuick=require("./testQuick"),watchFull=()=>watch(gulpConfig.watchSearch).on("change",(e=>{const r=new RegExp("^".concat(gulpConfig.srcPath,"(.*\\/).+\\.js$"),"i");return parallel(testQuick,series((()=>distFor(e,e.replace(r,"".concat(gulpConfig.distPath,"$1")))),bundle))()}));module.exports=watchFull;
package/dist/watchTest.js CHANGED
@@ -1,18 +1,17 @@
1
- 'use strict'
2
-
3
- var gulpConfig = require('../gulp.config.js')
4
- var _require = require('gulp')
5
- var series = _require.series
6
- var watch = _require.watch
7
- var testQuick = require('./testQuick')
8
-
1
+ 'use strict'
2
+
3
+ const gulpConfig = require('../gulp.config.js')
4
+ const {
5
+ series,
6
+ watch
7
+ } = require('gulp')
8
+ const testQuick = require('./testQuick')
9
+
9
10
  /**
10
11
  * Watch for changes and run the tests.
11
12
  * @returns {*}
12
- */
13
- var watchTest = function watchTest () {
14
- return watch(gulpConfig.watchSearch, {
15
- ignoreInitial: false
16
- }, series(testQuick))
17
- }
18
- module.exports = watchTest
13
+ */
14
+ const watchTest = () => watch(gulpConfig.watchSearch, {
15
+ ignoreInitial: false
16
+ }, series(testQuick))
17
+ module.exports = watchTest
@@ -1 +1 @@
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;
1
+ "use strict";const gulpConfig=require("../gulp.config.js"),{series:series,watch:watch}=require("gulp"),testQuick=require("./testQuick"),watchTest=()=>watch(gulpConfig.watchSearch,{ignoreInitial:!1},series(testQuick));module.exports=watchTest;
@@ -1,17 +1,17 @@
1
- const fs = require('fs')
2
- const gulpConfig = require('../gulp.config.js')
3
- const jsdoc2md = require('jsdoc-to-markdown')
4
- const { globSync } = require('glob')
5
-
6
- /**
7
- * Appends all the jsdoc comments to the readme file. Assumes empty or templated file.
8
- * @returns {string|Uint8Array}
9
- */
10
- const addToReadme = done => {
11
- const files = globSync(gulpConfig.srcSearch)
12
- const readme = jsdoc2md.renderSync({ files: files })
13
- fs.appendFileSync('README.md', readme, 'utf8')
14
- done()
15
- }
16
-
17
- module.exports = addToReadme
1
+ const fs = require('fs')
2
+ const gulpConfig = require('../gulp.config.js')
3
+ const jsdoc2md = require('jsdoc-to-markdown')
4
+ const { globSync } = require('glob')
5
+
6
+ /**
7
+ * Appends all the jsdoc comments to the readme file. Assumes empty or templated file.
8
+ * @returns {string|Uint8Array}
9
+ */
10
+ const addToReadme = done => {
11
+ const files = globSync(gulpConfig.srcSearch)
12
+ const readme = jsdoc2md.renderSync({ files: files })
13
+ fs.appendFileSync('README.md', readme, 'utf8')
14
+ done()
15
+ }
16
+
17
+ module.exports = addToReadme
@@ -1,25 +1,25 @@
1
- const bundle = require('./bundle')
2
- const bundleLint = require('./bundleLint')
3
- const bundleMinify = require('./bundleMinify')
4
- const clean = require('./clean')
5
- const compileReadme = require('./compileReadme')
6
- const dist = require('./dist')
7
- const distLint = require('./distLint')
8
- const distMinify = require('./distMinify')
9
- const { parallel, series } = require('gulp')
10
- const gulpConfig = require('../gulp.config.js')
11
- const testFull = require('./testFull')
12
-
13
- /**
14
- * Runs several processes to build and validate the project.
15
- * Cleans, distributes (lint and minify), bundles (lint and minify), creates the readme, then runs the tests.
16
- */
17
- const build = parallel(
18
- gulpConfig.nodeOnly
19
- ? series(clean, dist, parallel(distLint, distMinify))
20
- : series(clean, dist, parallel(distLint, distMinify), bundle, parallel(bundleLint, bundleMinify)),
21
- compileReadme,
22
- testFull
23
- )
24
-
25
- module.exports = build
1
+ const bundle = require('./bundle')
2
+ const bundleLint = require('./bundleLint')
3
+ const bundleMinify = require('./bundleMinify')
4
+ const clean = require('./clean')
5
+ const compileReadme = require('./compileReadme')
6
+ const dist = require('./dist')
7
+ const distLint = require('./distLint')
8
+ const distMinify = require('./distMinify')
9
+ const { parallel, series } = require('gulp')
10
+ const gulpConfig = require('../gulp.config.js')
11
+ const testFull = require('./testFull')
12
+
13
+ /**
14
+ * Runs several processes to build and validate the project.
15
+ * Cleans, distributes (lint and minify), bundles (lint and minify), creates the readme, then runs the tests.
16
+ */
17
+ const build = parallel(
18
+ gulpConfig.nodeOnly
19
+ ? series(clean, dist, parallel(distLint, distMinify))
20
+ : series(clean, dist, parallel(distLint, distMinify), bundle, parallel(bundleLint, bundleMinify)),
21
+ compileReadme,
22
+ testFull
23
+ )
24
+
25
+ module.exports = build
@@ -1,15 +1,15 @@
1
- const browserify = require('browserify')
2
- const { dest } = require('gulp')
3
- const gulpConfig = require('../gulp.config.js')
4
- const source = require('vinyl-source-stream')
5
-
6
- /**
7
- * Starting at the distribution entry point, bundle all the files into a single file and store them in the specified output directory.
8
- * @returns {*}
9
- */
10
- const bundle = () => browserify(gulpConfig.distMain)
11
- .bundle()
12
- .pipe(source(`${gulpConfig.browserName}.js`))
13
- .pipe(dest(gulpConfig.browserPath))
14
-
15
- module.exports = bundle
1
+ const browserify = require('browserify')
2
+ const { dest } = require('gulp')
3
+ const gulpConfig = require('../gulp.config.js')
4
+ const source = require('vinyl-source-stream')
5
+
6
+ /**
7
+ * Starting at the distribution entry point, bundle all the files into a single file and store them in the specified output directory.
8
+ * @returns {*}
9
+ */
10
+ const bundle = () => browserify(gulpConfig.distMain)
11
+ .bundle()
12
+ .pipe(source(`${gulpConfig.browserName}.js`))
13
+ .pipe(dest(gulpConfig.browserPath))
14
+
15
+ module.exports = bundle
@@ -1,17 +1,17 @@
1
- const { dest, src } = require('gulp')
2
- const gulpConfig = require('../gulp.config.js')
3
- const standard = require('gulp-standard')
4
-
5
- /**
6
- * Applies Standard code style linting to bundled file.
7
- * @returns {*}
8
- */
9
- const bundleLint = () => src(`${gulpConfig.browserPath}/${gulpConfig.browserName}.js`)
10
- .pipe(standard({ fix: true }))
11
- .pipe(standard.reporter('default', {
12
- fix: true,
13
- quiet: true
14
- }))
15
- .pipe(dest(gulpConfig.browserPath))
16
-
17
- module.exports = bundleLint
1
+ const { dest, src } = require('gulp')
2
+ const gulpConfig = require('../gulp.config.js')
3
+ const standard = require('gulp-standard')
4
+
5
+ /**
6
+ * Applies Standard code style linting to bundled file.
7
+ * @returns {*}
8
+ */
9
+ const bundleLint = () => src(`${gulpConfig.browserPath}/${gulpConfig.browserName}.js`)
10
+ .pipe(standard({ fix: true }))
11
+ .pipe(standard.reporter('default', {
12
+ fix: true,
13
+ quiet: true
14
+ }))
15
+ .pipe(dest(gulpConfig.browserPath))
16
+
17
+ module.exports = bundleLint
@@ -1,15 +1,15 @@
1
- const { dest, src } = require('gulp')
2
- const gulpConfig = require('../gulp.config.js')
3
- const { default: uglify } = require('gulp-uglify-es')
4
- const rename = require('gulp-rename')
5
-
6
- /**
7
- * Creates the minified bundle file.
8
- * @returns {*}
9
- */
10
- const bundleMinify = () => src(`${gulpConfig.browserPath}/${gulpConfig.browserName}.js`)
11
- .pipe(uglify())
12
- .pipe(rename({ extname: '.min.js' }))
13
- .pipe(dest(gulpConfig.browserPath))
14
-
15
- module.exports = bundleMinify
1
+ const { dest, src } = require('gulp')
2
+ const gulpConfig = require('../gulp.config.js')
3
+ const { default: uglify } = require('gulp-uglify-es')
4
+ const rename = require('gulp-rename')
5
+
6
+ /**
7
+ * Creates the minified bundle file.
8
+ * @returns {*}
9
+ */
10
+ const bundleMinify = () => src(`${gulpConfig.browserPath}/${gulpConfig.browserName}.js`)
11
+ .pipe(uglify())
12
+ .pipe(rename({ extname: '.min.js' }))
13
+ .pipe(dest(gulpConfig.browserPath))
14
+
15
+ module.exports = bundleMinify
@@ -1,10 +1,10 @@
1
- const addToReadme = require('./addToReadme')
2
- const readmeTemplate = require('./readmeTemplate')
3
- const { series } = require('gulp')
4
-
5
- /**
6
- * Generate the README.md file based off of the template, then append the generated documentation.
7
- */
8
- const compileReadme = series(readmeTemplate, addToReadme)
9
-
10
- module.exports = compileReadme
1
+ const addToReadme = require('./addToReadme')
2
+ const readmeTemplate = require('./readmeTemplate')
3
+ const { series } = require('gulp')
4
+
5
+ /**
6
+ * Generate the README.md file based off of the template, then append the generated documentation.
7
+ */
8
+ const compileReadme = series(readmeTemplate, addToReadme)
9
+
10
+ module.exports = compileReadme
@@ -1,11 +1,11 @@
1
- const { series } = require('gulp')
2
- const dist = require('./dist')
3
- const bundle = require('./bundle')
4
- const gulpConfig = require('../gulp.config')
5
-
6
- /**
7
- * Recommended as the default task, runs the simple dist and bundle tasks.
8
- */
9
- const defaultCmd = gulpConfig.nodeOnly ? series(dist) : series(dist, bundle)
10
-
11
- module.exports = defaultCmd
1
+ const { series } = require('gulp')
2
+ const dist = require('./dist')
3
+ const bundle = require('./bundle')
4
+ const gulpConfig = require('../gulp.config')
5
+
6
+ /**
7
+ * Recommended as the default task, runs the simple dist and bundle tasks.
8
+ */
9
+ const defaultCmd = gulpConfig.nodeOnly ? series(dist) : series(dist, bundle)
10
+
11
+ module.exports = defaultCmd
package/functions/dist.js CHANGED
@@ -1,9 +1,9 @@
1
- const distFor = require('./distFor.js')
2
-
3
- /**
4
- * Simplified distribution tasks which will use arguments from distFor.
5
- * @returns {*}
6
- */
7
- const dist = () => distFor()
8
-
9
- module.exports = dist
1
+ const distFor = require('./distFor.js')
2
+
3
+ /**
4
+ * Simplified distribution tasks which will use arguments from distFor.
5
+ * @returns {*}
6
+ */
7
+ const dist = () => distFor()
8
+
9
+ module.exports = dist
@@ -1,15 +1,15 @@
1
- const babel = require('gulp-babel')
2
- const { dest, src } = require('gulp')
3
- const gulpConfig = require('../gulp.config.js')
4
-
5
- /**
6
- * Build the distribution for a given source pattern.
7
- * @param {string|array} srcPath
8
- * @param {string} destPath
9
- * @returns {*}
10
- */
11
- const distFor = (srcPath = gulpConfig.srcSearch, destPath = gulpConfig.distPath) => src(srcPath)
12
- .pipe(babel())
13
- .pipe(dest(destPath))
14
-
15
- module.exports = distFor
1
+ const babel = require('gulp-babel')
2
+ const { dest, src } = require('gulp')
3
+ const gulpConfig = require('../gulp.config.js')
4
+
5
+ /**
6
+ * Build the distribution for a given source pattern.
7
+ * @param {string|array} srcPath
8
+ * @param {string} destPath
9
+ * @returns {*}
10
+ */
11
+ const distFor = (srcPath = gulpConfig.srcSearch, destPath = gulpConfig.distPath) => src(srcPath)
12
+ .pipe(babel())
13
+ .pipe(dest(destPath))
14
+
15
+ module.exports = distFor
@@ -1,17 +1,17 @@
1
- const gulpConfig = require('../gulp.config.js')
2
- const { dest, src } = require('gulp')
3
- const standard = require('gulp-standard')
4
-
5
- /**
6
- * Applies Standard code style linting to distribution files.
7
- * @returns {*}
8
- */
9
- const distLint = () => src(gulpConfig.distSearch)
10
- .pipe(standard({ fix: true }))
11
- .pipe(standard.reporter('default', {
12
- fix: true,
13
- quiet: true
14
- }))
15
- .pipe(dest(gulpConfig.distPath))
16
-
17
- module.exports = distLint
1
+ const gulpConfig = require('../gulp.config.js')
2
+ const { dest, src } = require('gulp')
3
+ const standard = require('gulp-standard')
4
+
5
+ /**
6
+ * Applies Standard code style linting to distribution files.
7
+ * @returns {*}
8
+ */
9
+ const distLint = () => src(gulpConfig.distSearch)
10
+ .pipe(standard({ fix: true }))
11
+ .pipe(standard.reporter('default', {
12
+ fix: true,
13
+ quiet: true
14
+ }))
15
+ .pipe(dest(gulpConfig.distPath))
16
+
17
+ module.exports = distLint
@@ -1,15 +1,15 @@
1
- const { dest, src } = require('gulp')
2
- const gulpConfig = require('../gulp.config.js')
3
- const { default: uglify } = require('gulp-uglify-es')
4
- const rename = require('gulp-rename')
5
-
6
- /**
7
- * Creates minified versions of the dist files.
8
- * @returns {*}
9
- */
10
- const distMinify = () => src(gulpConfig.distSearch)
11
- .pipe(uglify())
12
- .pipe(rename({ extname: '.min.js' }))
13
- .pipe(dest(gulpConfig.distPath))
14
-
15
- module.exports = distMinify
1
+ const { dest, src } = require('gulp')
2
+ const gulpConfig = require('../gulp.config.js')
3
+ const { default: uglify } = require('gulp-uglify-es')
4
+ const rename = require('gulp-rename')
5
+
6
+ /**
7
+ * Creates minified versions of the dist files.
8
+ * @returns {*}
9
+ */
10
+ const distMinify = () => src(gulpConfig.distSearch)
11
+ .pipe(uglify())
12
+ .pipe(rename({ extname: '.min.js' }))
13
+ .pipe(dest(gulpConfig.distPath))
14
+
15
+ module.exports = distMinify
@@ -1,13 +1,13 @@
1
- const { dest, src } = require('gulp')
2
- const gulpConfig = require('../gulp.config.js')
3
- const rename = require('gulp-rename')
4
-
5
- /**
6
- * Copy a readme template into the README.md file.
7
- * @returns {*}
8
- */
9
- const readmeTemplate = () => src(gulpConfig.readmeTemplate)
10
- .pipe(rename('README.md'))
11
- .pipe(dest('.'))
12
-
13
- module.exports = readmeTemplate
1
+ const { dest, src } = require('gulp')
2
+ const gulpConfig = require('../gulp.config.js')
3
+ const rename = require('gulp-rename')
4
+
5
+ /**
6
+ * Copy a readme template into the README.md file.
7
+ * @returns {*}
8
+ */
9
+ const readmeTemplate = () => src(gulpConfig.readmeTemplate)
10
+ .pipe(rename('README.md'))
11
+ .pipe(dest('.'))
12
+
13
+ module.exports = readmeTemplate
@@ -1,10 +1,10 @@
1
- const gulpConfig = require('../gulp.config.js');
2
- const { runCLI: jest } = require('jest')
3
-
4
- /**
5
- * Run all tests with jest.
6
- * @returns {Promise<*>}
7
- */
8
- const testFull = async () => await jest({}, gulpConfig.testPath)
9
-
10
- module.exports = testFull
1
+ const gulpConfig = require('../gulp.config.js');
2
+ const { runCLI: jest } = require('jest')
3
+
4
+ /**
5
+ * Run all tests with jest.
6
+ * @returns {Promise<*>}
7
+ */
8
+ const testFull = async () => await jest({}, gulpConfig.testPath)
9
+
10
+ module.exports = testFull