js-build-tools 6.2.0 → 6.2.2

package/dist/build.js

@@ -1,75 +1,73 @@
-"use strict";
-
-require("core-js/modules/esnext.weak-map.delete-all.js");
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.build = void 0;
-var _bundle = require("./bundle.js");
-var _bundleMinify = require("./bundleMinify.js");
-var _partials = require("./partials.js");
-var _compileReadme = require("./compileReadme.js");
-var _typeDocs = require("./typeDocs.js");
-var _jsdocDocs = require("./jsdocDocs.js");
-var _distMinify = require("./distMinify.js");
-var _sourceLint = require("./sourceLint.js");
-var _gulp = require("gulp");
-var gulpConfig = _interopRequireWildcard(require("../gulp.config.js"));
-var _copyFonts = require("./copyFonts.js");
-var _images = require("./images.js");
-var _sass = require("./sass.js");
-var _testFull = require("./testFull.js");
-var cache;
-function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var r, c, a = Object.defineProperty, n = { __proto__: null, default: e }; if (Object(e) !== e) return n; if (cache || "function" != typeof WeakMap || (cache = new WeakMap()), cache) { if (cache.has(e)) return cache.get(e); cache.set(e, n); } for (c in e) "default" !== c && {}.hasOwnProperty.call(e, c) && ((r = a && Object.getOwnPropertyDescriptor(e, c)) && (r.get || r.set) ? a(n, c, r) : n[c] = e[c]); return n; }
+"use strict";
+
+require("core-js/modules/esnext.weak-map.delete-all.js");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.build = void 0;
+var _bundle = require("./bundle.js");
+var _bundleMinify = require("./bundleMinify.js");
+var _partials = require("./partials.js");
+var _compileReadme = require("./compileReadme.js");
+var _typeDocs = require("./typeDocs.js");
+var _jsdocDocs = require("./jsdocDocs.js");
+var _distMinify = require("./distMinify.js");
+var _sourceLint = require("./sourceLint.js");
+var _gulp = require("gulp");
+var gulpConfig = _interopRequireWildcard(require("../gulp.config.js"));
+var _copyFonts = require("./copyFonts.js");
+var _images = require("./images.js");
+var _resolveDocsMethod = require("./partials/resolveDocsMethod.js");
+var _sass = require("./sass.js");
+var _testFull = require("./testFull.js");
+var cache;
+function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var r, c, a = Object.defineProperty, n = { __proto__: null, default: e }; if (Object(e) !== e) return n; if (cache || "function" != typeof WeakMap || (cache = new WeakMap()), cache) { if (cache.has(e)) return cache.get(e); cache.set(e, n); } for (c in e) "default" !== c && {}.hasOwnProperty.call(e, c) && ((r = a && Object.getOwnPropertyDescriptor(e, c)) && (r.get || r.set) ? a(n, c, r) : n[c] = e[c]); return n; }
 /**
  * Runs several processes to build and validate the project.
  * Cleans and lints the source, distributes and minifies, bundles and minifies, creates the readme, then runs the
  * tests.
  * @memberOf module:js-build-tools
  * @returns {stream.Stream}
- */
-const build = (done = null) => {
-  const buildActions = [(0, _partials.distSeries)(), _distMinify.distMinify];
-  const generateDocs = gulpConfig.get('docs.enabled');
-  // docs.method picks the engine explicitly; left unset (false, the default), it's inferred from
-  // typescript.enabled - every existing TypeScript project's config, which never sets method, keeps producing
-  // TypeDoc output exactly as it always has.
-  const docsMethod = gulpConfig.get('docs.method') || (gulpConfig.get('typescript.enabled') ? 'typedoc' : 'jsdoc');
-  if (generateDocs) {
-    // The documentation is generated from the source itself, the readme is written by hand
-    buildActions.push(docsMethod === 'jsdoc' ? _jsdocDocs.jsdocDocs : _typeDocs.typeDocs);
-  } else if (gulpConfig.get('typescript.enabled')) {
-    // For ts usage, we need to run the readme on the dist directly since that is where the .js files are located
-    buildActions.push(_compileReadme.compileReadme);
-  }
-  if (gulpConfig.get('browser.enabled')) {
-    // If not 'nodeOnly' then we also want to bundle for browser after we complete the dist directory
-    buildActions.push(_bundle.bundle);
-    buildActions.push(_bundleMinify.bundleMinify);
-  }
-  const runActions = [(0, _gulp.series)(...buildActions)];
-  if (!generateDocs && !gulpConfig.get('typescript.enabled')) {
-    // Since we didn't run this in series after dist because of typescript, we need to run it now. Potentially faster here.
-    runActions.push(_compileReadme.compileReadme);
-  }
-  runActions.push(_testFull.testFull);
-  if (gulpConfig.get('fonts.enabled')) {
-    // Conditionally add Fonts process
-    runActions.push(_copyFonts.copyFonts);
-  }
-  if (gulpConfig.get('images.enabled')) {
-    // Conditionally add Images process
-    runActions.push(_images.images);
-  }
-  if (gulpConfig.get('sass.enabled')) {
-    // Conditionally add SASS process
-    runActions.push(_sass.sass);
-  }
-  // clean has to finish before anything writes into the output folders - images, fonts and sass all write into
-  // browser/, so running clean in parallel with them races (ENOTEMPTY errors from clean, or output deleted mid-write).
-  // sourceLint fixes the real source in place before anything compiles from it (distSeries, tsFor inside it), so a
-  // build never reads a mix of pre- and post-fix content; clean only touches dist/browser output, so the two can
-  // run alongside each other.
-  return (0, _gulp.series)((0, _gulp.parallel)(_partials.clean, _sourceLint.sourceLint), (0, _gulp.parallel)(...runActions))(done);
-};
+ */
+const build = (done = null) => {
+  const buildActions = [(0, _partials.distSeries)(), _distMinify.distMinify];
+  const generateDocs = gulpConfig.get('docs.enabled');
+  const docsMethod = (0, _resolveDocsMethod.resolveDocsMethod)();
+  if (generateDocs) {
+    // The documentation is generated from the source itself, the readme is written by hand
+    buildActions.push(docsMethod === 'jsdoc' ? _jsdocDocs.jsdocDocs : _typeDocs.typeDocs);
+  } else if (gulpConfig.get('typescript.enabled')) {
+    // For ts usage, we need to run the readme on the dist directly since that is where the .js files are located
+    buildActions.push(_compileReadme.compileReadme);
+  }
+  if (gulpConfig.get('browser.enabled')) {
+    // If not 'nodeOnly' then we also want to bundle for browser after we complete the dist directory
+    buildActions.push(_bundle.bundle);
+    buildActions.push(_bundleMinify.bundleMinify);
+  }
+  const runActions = [(0, _gulp.series)(...buildActions)];
+  if (!generateDocs && !gulpConfig.get('typescript.enabled')) {
+    // Since we didn't run this in series after dist because of typescript, we need to run it now. Potentially faster here.
+    runActions.push(_compileReadme.compileReadme);
+  }
+  runActions.push(_testFull.testFull);
+  if (gulpConfig.get('fonts.enabled')) {
+    // Conditionally add Fonts process
+    runActions.push(_copyFonts.copyFonts);
+  }
+  if (gulpConfig.get('images.enabled')) {
+    // Conditionally add Images process
+    runActions.push(_images.images);
+  }
+  if (gulpConfig.get('sass.enabled')) {
+    // Conditionally add SASS process
+    runActions.push(_sass.sass);
+  }
+  // clean has to finish before anything writes into the output folders - images, fonts and sass all write into
+  // browser/, so running clean in parallel with them races (ENOTEMPTY errors from clean, or output deleted mid-write).
+  // sourceLint fixes the real source in place before anything compiles from it (distSeries, tsFor inside it), so a
+  // build never reads a mix of pre- and post-fix content; clean only touches dist/browser output, so the two can
+  // run alongside each other.
+  return (0, _gulp.series)((0, _gulp.parallel)(_partials.clean, _sourceLint.sourceLint), (0, _gulp.parallel)(...runActions))(done);
+};
 exports.build = build;

package/dist/build.min.js

@@ -1 +1 @@
-"use strict";require("core-js/modules/esnext.weak-map.delete-all.js"),Object.defineProperty(exports,"__esModule",{value:!0}),exports.build=void 0;var cache,_bundle=require("./bundle.js"),_bundleMinify=require("./bundleMinify.js"),_partials=require("./partials.js"),_compileReadme=require("./compileReadme.js"),_typeDocs=require("./typeDocs.js"),_jsdocDocs=require("./jsdocDocs.js"),_distMinify=require("./distMinify.js"),_sourceLint=require("./sourceLint.js"),_gulp=require("gulp"),gulpConfig=_interopRequireWildcard(require("../gulp.config.js")),_copyFonts=require("./copyFonts.js"),_images=require("./images.js"),_sass=require("./sass.js"),_testFull=require("./testFull.js");function _interopRequireWildcard(e,s){if(!s&&e&&e.__esModule)return e;var i,t,r=Object.defineProperty,l={__proto__:null,default:e};if(Object(e)!==e)return l;if(cache||"function"!=typeof WeakMap||(cache=new WeakMap),cache){if(cache.has(e))return cache.get(e);cache.set(e,l)}for(t in e)"default"!==t&&{}.hasOwnProperty.call(e,t)&&((i=r&&Object.getOwnPropertyDescriptor(e,t))&&(i.get||i.set)?r(l,t,i):l[t]=e[t]);return l}const build=(e=null)=>{const s=[(0,_partials.distSeries)(),_distMinify.distMinify],i=gulpConfig.get("docs.enabled"),t=gulpConfig.get("docs.method")||(gulpConfig.get("typescript.enabled")?"typedoc":"jsdoc");i?s.push("jsdoc"===t?_jsdocDocs.jsdocDocs:_typeDocs.typeDocs):gulpConfig.get("typescript.enabled")&&s.push(_compileReadme.compileReadme),gulpConfig.get("browser.enabled")&&(s.push(_bundle.bundle),s.push(_bundleMinify.bundleMinify));const r=[(0,_gulp.series)(...s)];return i||gulpConfig.get("typescript.enabled")||r.push(_compileReadme.compileReadme),r.push(_testFull.testFull),gulpConfig.get("fonts.enabled")&&r.push(_copyFonts.copyFonts),gulpConfig.get("images.enabled")&&r.push(_images.images),gulpConfig.get("sass.enabled")&&r.push(_sass.sass),(0,_gulp.series)((0,_gulp.parallel)(_partials.clean,_sourceLint.sourceLint),(0,_gulp.parallel)(...r))(e)};exports.build=build;
+"use strict";require("core-js/modules/esnext.weak-map.delete-all.js"),Object.defineProperty(exports,"__esModule",{value:!0}),exports.build=void 0;var cache,_bundle=require("./bundle.js"),_bundleMinify=require("./bundleMinify.js"),_partials=require("./partials.js"),_compileReadme=require("./compileReadme.js"),_typeDocs=require("./typeDocs.js"),_jsdocDocs=require("./jsdocDocs.js"),_distMinify=require("./distMinify.js"),_sourceLint=require("./sourceLint.js"),_gulp=require("gulp"),gulpConfig=_interopRequireWildcard(require("../gulp.config.js")),_copyFonts=require("./copyFonts.js"),_images=require("./images.js"),_resolveDocsMethod=require("./partials/resolveDocsMethod.js"),_sass=require("./sass.js"),_testFull=require("./testFull.js");function _interopRequireWildcard(e,s){if(!s&&e&&e.__esModule)return e;var i,r,t=Object.defineProperty,l={__proto__:null,default:e};if(Object(e)!==e)return l;if(cache||"function"!=typeof WeakMap||(cache=new WeakMap),cache){if(cache.has(e))return cache.get(e);cache.set(e,l)}for(r in e)"default"!==r&&{}.hasOwnProperty.call(e,r)&&((i=t&&Object.getOwnPropertyDescriptor(e,r))&&(i.get||i.set)?t(l,r,i):l[r]=e[r]);return l}const build=(e=null)=>{const s=[(0,_partials.distSeries)(),_distMinify.distMinify],i=gulpConfig.get("docs.enabled"),r=(0,_resolveDocsMethod.resolveDocsMethod)();i?s.push("jsdoc"===r?_jsdocDocs.jsdocDocs:_typeDocs.typeDocs):gulpConfig.get("typescript.enabled")&&s.push(_compileReadme.compileReadme),gulpConfig.get("browser.enabled")&&(s.push(_bundle.bundle),s.push(_bundleMinify.bundleMinify));const t=[(0,_gulp.series)(...s)];return i||gulpConfig.get("typescript.enabled")||t.push(_compileReadme.compileReadme),t.push(_testFull.testFull),gulpConfig.get("fonts.enabled")&&t.push(_copyFonts.copyFonts),gulpConfig.get("images.enabled")&&t.push(_images.images),gulpConfig.get("sass.enabled")&&t.push(_sass.sass),(0,_gulp.series)((0,_gulp.parallel)(_partials.clean,_sourceLint.sourceLint),(0,_gulp.parallel)(...t))(e)};exports.build=build;

package/dist/docs.js

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.docs = void 0;
+var _jsdocDocs = require("./jsdocDocs.js");
+var _resolveDocsMethod = require("./partials/resolveDocsMethod.js");
+var _typeDocs = require("./typeDocs.js");
+/**
+ * Generate the HTML documentation with whichever engine docs.method (or its typescript.enabled-based default)
+ * resolves to - see {@link module:partials.resolveDocsMethod}. The standalone counterpart to build's own
+ * internal branching, for running `gulp docs` directly instead of as part of a full build.
+ * @memberOf module:js-build-tools
+ * @param {Function} [done]
+ * @returns {*}
+ */
+const docs = (done = null) => ((0, _resolveDocsMethod.resolveDocsMethod)() === 'jsdoc' ? _jsdocDocs.jsdocDocs : _typeDocs.typeDocs)(done);
+exports.docs = docs;

package/dist/docs.min.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),exports.docs=void 0;var _jsdocDocs=require("./jsdocDocs.js"),_resolveDocsMethod=require("./partials/resolveDocsMethod.js"),_typeDocs=require("./typeDocs.js");const docs=(o=null)=>("jsdoc"===(0,_resolveDocsMethod.resolveDocsMethod)()?_jsdocDocs.jsdocDocs:_typeDocs.typeDocs)(o);exports.docs=docs;

package/dist/partials/resolveDocsMethod.js

@@ -0,0 +1,19 @@
+"use strict";
+
+require("core-js/modules/esnext.weak-map.delete-all.js");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.resolveDocsMethod = void 0;
+var gulpConfig = _interopRequireWildcard(require("../../gulp.config.js"));
+var cache;
+function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var r, c, a = Object.defineProperty, n = { __proto__: null, default: e }; if (Object(e) !== e) return n; if (cache || "function" != typeof WeakMap || (cache = new WeakMap()), cache) { if (cache.has(e)) return cache.get(e); cache.set(e, n); } for (c in e) "default" !== c && {}.hasOwnProperty.call(e, c) && ((r = a && Object.getOwnPropertyDescriptor(e, c)) && (r.get || r.set) ? a(n, c, r) : n[c] = e[c]); return n; }
+/**
+ * Pick which engine generates the HTML documentation: docs.method picks it explicitly; left unset (false, the
+ * default), it's inferred from typescript.enabled - every existing TypeScript project's config, which never
+ * sets method, keeps producing TypeDoc output exactly as it always has.
+ * @memberOf module:partials
+ * @returns {'typedoc'|'jsdoc'}
+ */
+const resolveDocsMethod = () => gulpConfig.get('docs.method') || (gulpConfig.get('typescript.enabled') ? 'typedoc' : 'jsdoc');
+exports.resolveDocsMethod = resolveDocsMethod;

package/dist/partials.js

@@ -1,136 +1,150 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "addToReadme", {
-  enumerable: true,
-  get: function () {
-    return _addToReadme.addToReadme;
-  }
-});
-Object.defineProperty(exports, "beginWatcher", {
-  enumerable: true,
-  get: function () {
-    return _beginWatcher.beginWatcher;
-  }
-});
-Object.defineProperty(exports, "clean", {
-  enumerable: true,
-  get: function () {
-    return _clean.clean;
-  }
-});
-Object.defineProperty(exports, "copyFor", {
-  enumerable: true,
-  get: function () {
-    return _copyFor.copyFor;
-  }
-});
-Object.defineProperty(exports, "distFor", {
-  enumerable: true,
-  get: function () {
-    return _distFor.distFor;
-  }
-});
-Object.defineProperty(exports, "distForSrc", {
-  enumerable: true,
-  get: function () {
-    return _distForSrc.distForSrc;
-  }
-});
-Object.defineProperty(exports, "distSeries", {
-  enumerable: true,
-  get: function () {
-    return _distSeries.distSeries;
-  }
-});
-Object.defineProperty(exports, "imagesFor", {
-  enumerable: true,
-  get: function () {
-    return _imagesFor.imagesFor;
-  }
-});
-Object.defineProperty(exports, "importModule", {
-  enumerable: true,
-  get: function () {
-    return _loadPeer.importModule;
-  }
-});
-Object.defineProperty(exports, "importPeer", {
-  enumerable: true,
-  get: function () {
-    return _loadPeer.importPeer;
-  }
-});
-Object.defineProperty(exports, "minifyFor", {
-  enumerable: true,
-  get: function () {
-    return _minifyFor.minifyFor;
-  }
-});
-Object.defineProperty(exports, "neostandardLint", {
-  enumerable: true,
-  get: function () {
-    return _neostandardLint.neostandardLint;
-  }
-});
-Object.defineProperty(exports, "readmeTemplate", {
-  enumerable: true,
-  get: function () {
-    return _readmeTemplate.readmeTemplate;
-  }
-});
-Object.defineProperty(exports, "removeDirectory", {
-  enumerable: true,
-  get: function () {
-    return _removeDirectory.removeDirectory;
-  }
-});
-Object.defineProperty(exports, "requirePeer", {
-  enumerable: true,
-  get: function () {
-    return _loadPeer.requirePeer;
-  }
-});
-Object.defineProperty(exports, "runOnChange", {
-  enumerable: true,
-  get: function () {
-    return _runOnChange.runOnChange;
-  }
-});
-Object.defineProperty(exports, "sassFor", {
-  enumerable: true,
-  get: function () {
-    return _sassFor.sassFor;
-  }
-});
-Object.defineProperty(exports, "tsFor", {
-  enumerable: true,
-  get: function () {
-    return _tsFor.tsFor;
-  }
-});
-Object.defineProperty(exports, "typeDocsFor", {
-  enumerable: true,
-  get: function () {
-    return _typeDocsFor.typeDocsFor;
-  }
-});
-var _addToReadme = require("./partials/addToReadme.js");
-var _beginWatcher = require("./partials/beginWatcher.js");
-var _clean = require("./partials/clean.js");
-var _copyFor = require("./partials/copyFor.js");
-var _distFor = require("./partials/distFor.js");
-var _distForSrc = require("./partials/distForSrc.js");
-var _distSeries = require("./partials/distSeries.js");
-var _imagesFor = require("./partials/imagesFor.js");
-var _loadPeer = require("./partials/loadPeer.js");
-var _minifyFor = require("./partials/minifyFor.js");
-var _neostandardLint = require("./partials/neostandardLint.js");
-var _readmeTemplate = require("./partials/readmeTemplate.js");
-var _removeDirectory = require("./partials/removeDirectory.js");
-var _runOnChange = require("./partials/runOnChange.js");
-var _sassFor = require("./partials/sassFor.js");
-var _tsFor = require("./partials/tsFor.js");
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "addToReadme", {
+  enumerable: true,
+  get: function () {
+    return _addToReadme.addToReadme;
+  }
+});
+Object.defineProperty(exports, "beginWatcher", {
+  enumerable: true,
+  get: function () {
+    return _beginWatcher.beginWatcher;
+  }
+});
+Object.defineProperty(exports, "clean", {
+  enumerable: true,
+  get: function () {
+    return _clean.clean;
+  }
+});
+Object.defineProperty(exports, "copyFor", {
+  enumerable: true,
+  get: function () {
+    return _copyFor.copyFor;
+  }
+});
+Object.defineProperty(exports, "distFor", {
+  enumerable: true,
+  get: function () {
+    return _distFor.distFor;
+  }
+});
+Object.defineProperty(exports, "distForSrc", {
+  enumerable: true,
+  get: function () {
+    return _distForSrc.distForSrc;
+  }
+});
+Object.defineProperty(exports, "distSeries", {
+  enumerable: true,
+  get: function () {
+    return _distSeries.distSeries;
+  }
+});
+Object.defineProperty(exports, "imagesFor", {
+  enumerable: true,
+  get: function () {
+    return _imagesFor.imagesFor;
+  }
+});
+Object.defineProperty(exports, "importModule", {
+  enumerable: true,
+  get: function () {
+    return _loadPeer.importModule;
+  }
+});
+Object.defineProperty(exports, "importPeer", {
+  enumerable: true,
+  get: function () {
+    return _loadPeer.importPeer;
+  }
+});
+Object.defineProperty(exports, "jsdocDocsFor", {
+  enumerable: true,
+  get: function () {
+    return _jsdocDocsFor.jsdocDocsFor;
+  }
+});
+Object.defineProperty(exports, "minifyFor", {
+  enumerable: true,
+  get: function () {
+    return _minifyFor.minifyFor;
+  }
+});
+Object.defineProperty(exports, "neostandardLint", {
+  enumerable: true,
+  get: function () {
+    return _neostandardLint.neostandardLint;
+  }
+});
+Object.defineProperty(exports, "readmeTemplate", {
+  enumerable: true,
+  get: function () {
+    return _readmeTemplate.readmeTemplate;
+  }
+});
+Object.defineProperty(exports, "removeDirectory", {
+  enumerable: true,
+  get: function () {
+    return _removeDirectory.removeDirectory;
+  }
+});
+Object.defineProperty(exports, "requirePeer", {
+  enumerable: true,
+  get: function () {
+    return _loadPeer.requirePeer;
+  }
+});
+Object.defineProperty(exports, "resolveDocsMethod", {
+  enumerable: true,
+  get: function () {
+    return _resolveDocsMethod.resolveDocsMethod;
+  }
+});
+Object.defineProperty(exports, "runOnChange", {
+  enumerable: true,
+  get: function () {
+    return _runOnChange.runOnChange;
+  }
+});
+Object.defineProperty(exports, "sassFor", {
+  enumerable: true,
+  get: function () {
+    return _sassFor.sassFor;
+  }
+});
+Object.defineProperty(exports, "tsFor", {
+  enumerable: true,
+  get: function () {
+    return _tsFor.tsFor;
+  }
+});
+Object.defineProperty(exports, "typeDocsFor", {
+  enumerable: true,
+  get: function () {
+    return _typeDocsFor.typeDocsFor;
+  }
+});
+var _addToReadme = require("./partials/addToReadme.js");
+var _beginWatcher = require("./partials/beginWatcher.js");
+var _clean = require("./partials/clean.js");
+var _copyFor = require("./partials/copyFor.js");
+var _distFor = require("./partials/distFor.js");
+var _distForSrc = require("./partials/distForSrc.js");
+var _distSeries = require("./partials/distSeries.js");
+var _imagesFor = require("./partials/imagesFor.js");
+var _loadPeer = require("./partials/loadPeer.js");
+var _jsdocDocsFor = require("./partials/jsdocDocsFor.js");
+var _minifyFor = require("./partials/minifyFor.js");
+var _neostandardLint = require("./partials/neostandardLint.js");
+var _readmeTemplate = require("./partials/readmeTemplate.js");
+var _removeDirectory = require("./partials/removeDirectory.js");
+var _resolveDocsMethod = require("./partials/resolveDocsMethod.js");
+var _runOnChange = require("./partials/runOnChange.js");
+var _sassFor = require("./partials/sassFor.js");
+var _tsFor = require("./partials/tsFor.js");
 var _typeDocsFor = require("./partials/typeDocsFor.js");

package/dist/partials.min.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),Object.defineProperty(exports,"addToReadme",{enumerable:!0,get:function(){return _addToReadme.addToReadme}}),Object.defineProperty(exports,"beginWatcher",{enumerable:!0,get:function(){return _beginWatcher.beginWatcher}}),Object.defineProperty(exports,"clean",{enumerable:!0,get:function(){return _clean.clean}}),Object.defineProperty(exports,"copyFor",{enumerable:!0,get:function(){return _copyFor.copyFor}}),Object.defineProperty(exports,"distFor",{enumerable:!0,get:function(){return _distFor.distFor}}),Object.defineProperty(exports,"distForSrc",{enumerable:!0,get:function(){return _distForSrc.distForSrc}}),Object.defineProperty(exports,"distSeries",{enumerable:!0,get:function(){return _distSeries.distSeries}}),Object.defineProperty(exports,"imagesFor",{enumerable:!0,get:function(){return _imagesFor.imagesFor}}),Object.defineProperty(exports,"importModule",{enumerable:!0,get:function(){return _loadPeer.importModule}}),Object.defineProperty(exports,"importPeer",{enumerable:!0,get:function(){return _loadPeer.importPeer}}),Object.defineProperty(exports,"minifyFor",{enumerable:!0,get:function(){return _minifyFor.minifyFor}}),Object.defineProperty(exports,"neostandardLint",{enumerable:!0,get:function(){return _neostandardLint.neostandardLint}}),Object.defineProperty(exports,"readmeTemplate",{enumerable:!0,get:function(){return _readmeTemplate.readmeTemplate}}),Object.defineProperty(exports,"removeDirectory",{enumerable:!0,get:function(){return _removeDirectory.removeDirectory}}),Object.defineProperty(exports,"requirePeer",{enumerable:!0,get:function(){return _loadPeer.requirePeer}}),Object.defineProperty(exports,"runOnChange",{enumerable:!0,get:function(){return _runOnChange.runOnChange}}),Object.defineProperty(exports,"sassFor",{enumerable:!0,get:function(){return _sassFor.sassFor}}),Object.defineProperty(exports,"tsFor",{enumerable:!0,get:function(){return _tsFor.tsFor}}),Object.defineProperty(exports,"typeDocsFor",{enumerable:!0,get:function(){return _typeDocsFor.typeDocsFor}});var _addToReadme=require("./partials/addToReadme.js"),_beginWatcher=require("./partials/beginWatcher.js"),_clean=require("./partials/clean.js"),_copyFor=require("./partials/copyFor.js"),_distFor=require("./partials/distFor.js"),_distForSrc=require("./partials/distForSrc.js"),_distSeries=require("./partials/distSeries.js"),_imagesFor=require("./partials/imagesFor.js"),_loadPeer=require("./partials/loadPeer.js"),_minifyFor=require("./partials/minifyFor.js"),_neostandardLint=require("./partials/neostandardLint.js"),_readmeTemplate=require("./partials/readmeTemplate.js"),_removeDirectory=require("./partials/removeDirectory.js"),_runOnChange=require("./partials/runOnChange.js"),_sassFor=require("./partials/sassFor.js"),_tsFor=require("./partials/tsFor.js"),_typeDocsFor=require("./partials/typeDocsFor.js");
+"use strict";Object.defineProperty(exports,"__esModule",{value:!0}),Object.defineProperty(exports,"addToReadme",{enumerable:!0,get:function(){return _addToReadme.addToReadme}}),Object.defineProperty(exports,"beginWatcher",{enumerable:!0,get:function(){return _beginWatcher.beginWatcher}}),Object.defineProperty(exports,"clean",{enumerable:!0,get:function(){return _clean.clean}}),Object.defineProperty(exports,"copyFor",{enumerable:!0,get:function(){return _copyFor.copyFor}}),Object.defineProperty(exports,"distFor",{enumerable:!0,get:function(){return _distFor.distFor}}),Object.defineProperty(exports,"distForSrc",{enumerable:!0,get:function(){return _distForSrc.distForSrc}}),Object.defineProperty(exports,"distSeries",{enumerable:!0,get:function(){return _distSeries.distSeries}}),Object.defineProperty(exports,"imagesFor",{enumerable:!0,get:function(){return _imagesFor.imagesFor}}),Object.defineProperty(exports,"importModule",{enumerable:!0,get:function(){return _loadPeer.importModule}}),Object.defineProperty(exports,"importPeer",{enumerable:!0,get:function(){return _loadPeer.importPeer}}),Object.defineProperty(exports,"jsdocDocsFor",{enumerable:!0,get:function(){return _jsdocDocsFor.jsdocDocsFor}}),Object.defineProperty(exports,"minifyFor",{enumerable:!0,get:function(){return _minifyFor.minifyFor}}),Object.defineProperty(exports,"neostandardLint",{enumerable:!0,get:function(){return _neostandardLint.neostandardLint}}),Object.defineProperty(exports,"readmeTemplate",{enumerable:!0,get:function(){return _readmeTemplate.readmeTemplate}}),Object.defineProperty(exports,"removeDirectory",{enumerable:!0,get:function(){return _removeDirectory.removeDirectory}}),Object.defineProperty(exports,"requirePeer",{enumerable:!0,get:function(){return _loadPeer.requirePeer}}),Object.defineProperty(exports,"resolveDocsMethod",{enumerable:!0,get:function(){return _resolveDocsMethod.resolveDocsMethod}}),Object.defineProperty(exports,"runOnChange",{enumerable:!0,get:function(){return _runOnChange.runOnChange}}),Object.defineProperty(exports,"sassFor",{enumerable:!0,get:function(){return _sassFor.sassFor}}),Object.defineProperty(exports,"tsFor",{enumerable:!0,get:function(){return _tsFor.tsFor}}),Object.defineProperty(exports,"typeDocsFor",{enumerable:!0,get:function(){return _typeDocsFor.typeDocsFor}});var _addToReadme=require("./partials/addToReadme.js"),_beginWatcher=require("./partials/beginWatcher.js"),_clean=require("./partials/clean.js"),_copyFor=require("./partials/copyFor.js"),_distFor=require("./partials/distFor.js"),_distForSrc=require("./partials/distForSrc.js"),_distSeries=require("./partials/distSeries.js"),_imagesFor=require("./partials/imagesFor.js"),_loadPeer=require("./partials/loadPeer.js"),_jsdocDocsFor=require("./partials/jsdocDocsFor.js"),_minifyFor=require("./partials/minifyFor.js"),_neostandardLint=require("./partials/neostandardLint.js"),_readmeTemplate=require("./partials/readmeTemplate.js"),_removeDirectory=require("./partials/removeDirectory.js"),_resolveDocsMethod=require("./partials/resolveDocsMethod.js"),_runOnChange=require("./partials/runOnChange.js"),_sassFor=require("./partials/sassFor.js"),_tsFor=require("./partials/tsFor.js"),_typeDocsFor=require("./partials/typeDocsFor.js");

package/functions/build.mjs

@@ -10,6 +10,7 @@ import { parallel, series } from 'gulp'
 import * as gulpConfig from '../gulp.config.mjs'
 import { copyFonts } from './copyFonts.mjs'
 import { images } from './images.mjs'
+import { resolveDocsMethod } from './partials/resolveDocsMethod.mjs'
 import { sass } from './sass.mjs'
 import { testFull } from './testFull.mjs'
 
@@ -23,10 +24,7 @@ import { testFull } from './testFull.mjs'
 export const build = (done = null) => {
   const buildActions = [distSeries(), distMinify]
   const generateDocs = gulpConfig.get('docs.enabled')
-  // docs.method picks the engine explicitly; left unset (false, the default), it's inferred from
-  // typescript.enabled - every existing TypeScript project's config, which never sets method, keeps producing
-  // TypeDoc output exactly as it always has.
-  const docsMethod = gulpConfig.get('docs.method') || (gulpConfig.get('typescript.enabled') ? 'typedoc' : 'jsdoc')
+  const docsMethod = resolveDocsMethod()
   if (generateDocs) {
     // The documentation is generated from the source itself, the readme is written by hand
     buildActions.push(docsMethod === 'jsdoc' ? jsdocDocs : typeDocs)

package/functions/docs.mjs

@@ -0,0 +1,13 @@
+import { jsdocDocs } from './jsdocDocs.mjs'
+import { resolveDocsMethod } from './partials/resolveDocsMethod.mjs'
+import { typeDocs } from './typeDocs.mjs'
+
+/**
+ * Generate the HTML documentation with whichever engine docs.method (or its typescript.enabled-based default)
+ * resolves to - see {@link module:partials.resolveDocsMethod}. The standalone counterpart to build's own
+ * internal branching, for running `gulp docs` directly instead of as part of a full build.
+ * @memberOf module:js-build-tools
+ * @param {Function} [done]
+ * @returns {*}
+ */
+export const docs = (done = null) => (resolveDocsMethod() === 'jsdoc' ? jsdocDocs : typeDocs)(done)

package/functions/docs.test.mjs

@@ -0,0 +1,45 @@
+import * as setUp from './test-helpers/setUp.mjs'
+import { docs } from './docs.mjs'
+import { typeDocs } from './typeDocs.mjs'
+import { jsdocDocs } from './jsdocDocs.mjs'
+
+const genericFunction = () => Promise.resolve(true)
+
+jest.mock('./typeDocs.mjs', () => ({ typeDocs: jest.fn(genericFunction) }))
+jest.mock('./jsdocDocs.mjs', () => ({ jsdocDocs: jest.fn(genericFunction) }))
+
+setUp.setDefaults('test-docs')
+const gulpConfig = setUp.gulpConfig
+
+beforeEach(() => setUp.beforeEach().then(() => {
+  typeDocs.mockClear()
+  jsdocDocs.mockClear()
+}))
+
+afterEach(setUp.afterEach)
+
+describe('docs', () => {
+  test('runs jsdocDocs when resolveDocsMethod infers jsdoc', async () => {
+    gulpConfig.set('typescript.enabled', false)
+    gulpConfig.set('docs.method', false)
+    await docs()
+    expect(jsdocDocs).toHaveBeenCalledTimes(1)
+    expect(typeDocs).not.toHaveBeenCalled()
+  })
+
+  test('runs typeDocs when resolveDocsMethod infers typedoc', async () => {
+    gulpConfig.set('typescript.enabled', true)
+    gulpConfig.set('docs.method', false)
+    await docs()
+    expect(typeDocs).toHaveBeenCalledTimes(1)
+    expect(jsdocDocs).not.toHaveBeenCalled()
+  })
+
+  test('docs.method overrides the typescript.enabled inference either way', async () => {
+    gulpConfig.set('typescript.enabled', true)
+    gulpConfig.set('docs.method', 'jsdoc')
+    await docs()
+    expect(jsdocDocs).toHaveBeenCalledTimes(1)
+    expect(typeDocs).not.toHaveBeenCalled()
+  })
+})

package/functions/partials/resolveDocsMethod.mjs

@@ -0,0 +1,10 @@
+import * as gulpConfig from '../../gulp.config.mjs'
+
+/**
+ * Pick which engine generates the HTML documentation: docs.method picks it explicitly; left unset (false, the
+ * default), it's inferred from typescript.enabled - every existing TypeScript project's config, which never
+ * sets method, keeps producing TypeDoc output exactly as it always has.
+ * @memberOf module:partials
+ * @returns {'typedoc'|'jsdoc'}
+ */
+export const resolveDocsMethod = () => gulpConfig.get('docs.method') || (gulpConfig.get('typescript.enabled') ? 'typedoc' : 'jsdoc')

package/functions/partials/resolveDocsMethod.test.mjs

@@ -0,0 +1,33 @@
+import * as setUp from '../test-helpers/setUp.mjs'
+import { resolveDocsMethod } from './resolveDocsMethod.mjs'
+
+setUp.setDefaults('test-resolve-docs-method')
+const gulpConfig = setUp.gulpConfig
+
+beforeEach(setUp.beforeEach)
+
+afterEach(setUp.afterEach)
+
+describe('resolveDocsMethod', () => {
+  test('infers jsdoc when typescript.enabled is false and docs.method is unset', () => {
+    gulpConfig.set('typescript.enabled', false)
+    gulpConfig.set('docs.method', false)
+    expect(resolveDocsMethod()).toBe('jsdoc')
+  })
+
+  test('infers typedoc when typescript.enabled is true and docs.method is unset', () => {
+    gulpConfig.set('typescript.enabled', true)
+    gulpConfig.set('docs.method', false)
+    expect(resolveDocsMethod()).toBe('typedoc')
+  })
+
+  test('docs.method overrides the typescript.enabled inference either way', () => {
+    gulpConfig.set('typescript.enabled', true)
+    gulpConfig.set('docs.method', 'jsdoc')
+    expect(resolveDocsMethod()).toBe('jsdoc')
+
+    gulpConfig.set('typescript.enabled', false)
+    gulpConfig.set('docs.method', 'typedoc')
+    expect(resolveDocsMethod()).toBe('typedoc')
+  })
+})

package/functions/partials.mjs

@@ -16,10 +16,12 @@ export { distForSrc } from './partials/distForSrc.mjs'
 export { distSeries } from './partials/distSeries.mjs'
 export { imagesFor } from './partials/imagesFor.mjs'
 export { importModule, importPeer, requirePeer } from './partials/loadPeer.mjs'
+export { jsdocDocsFor } from './partials/jsdocDocsFor.mjs'
 export { minifyFor } from './partials/minifyFor.mjs'
 export { neostandardLint } from './partials/neostandardLint.mjs'
 export { readmeTemplate } from './partials/readmeTemplate.mjs'
 export { removeDirectory } from './partials/removeDirectory.mjs'
+export { resolveDocsMethod } from './partials/resolveDocsMethod.mjs'
 export { runOnChange } from './partials/runOnChange.mjs'
 export { sassFor } from './partials/sassFor.mjs'
 export { tsFor } from './partials/tsFor.mjs'

package/functions/partials.test.mjs

@@ -2,6 +2,6 @@ import * as partials from './partials.mjs'
 
 describe('partials', () => {
   test('is object with all partial exports', () => {
-    expect(Object.keys(partials).length).toBe(19)
+    expect(Object.keys(partials).length).toBe(21)
   })
 })

package/gulpfile.base.mjs

@@ -13,6 +13,7 @@ export { copyFiles } from './functions/copyFiles.mjs'
 export { copyFonts } from './functions/copyFonts.mjs'
 export { defaultCmd } from './functions/default.mjs'
 export { dist } from './functions/dist.mjs'
+export { docs } from './functions/docs.mjs'
 export { distMinify } from './functions/distMinify.mjs'
 export * as gulpConfig from './gulp.config.mjs'
 export { images } from './functions/images.mjs'
@@ -23,7 +24,7 @@ export { sourceLint } from './functions/sourceLint.mjs'
 export { testFull } from './functions/testFull.mjs'
 export * as testHelpers from './functions/testHelpers.mjs'
 export { testQuick } from './functions/testQuick.mjs'
-export { typeDocs as docs } from './functions/typeDocs.mjs'
+export { typeDocs } from './functions/typeDocs.mjs'
 export { typeScript as typescript } from './functions/typeScript.mjs'
 export { watchFull } from './functions/watchFull.mjs'
 export { watchTest } from './functions/watchTest.mjs'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-build-tools",
-  "version": "6.2.0",
+  "version": "6.2.2",
   "description": "Standardised build process with gulp.",
   "main": "gulpfile.base.js",
   "exports": {
@@ -22,6 +22,8 @@
     "dev": "gulp",
     "htmldocs": "jsdoc -R MAIN.md -c ./.jsdoc.conf.js -d docs",
     "readme": "gulp readme",
+    "release": "release-it",
+    "release:dry-run": "release-it --dry-run",
     "test": "gulp testFull",
     "test:quick": "gulp testQuick",
     "watch": "gulp watchFull",
@@ -117,6 +119,7 @@
     "clean-jsdoc-theme": "^5.2.0",
     "gulp-imagemin": "github:jheagle/gulp-imagemin#common-js-compatibility",
     "jsdoc": "^4.0.5",
+    "release-it": "^21.1.1",
     "typedoc": "^0.28.20",
     "typescript": "^6.0.3"
   },