js-build-tools 5.1.1 → 5.3.0

package/gulp.config.mjs

@@ -52,6 +52,14 @@ import { fileExists } from 'test-filesystem'
  * @property {StringSetting} from - The name to use for the browser-bundled output file (.js will be appended).
  * @property {StringSetting} name - The search pattern used for retrieving compiled distribution files.
  * @property {StringSetting} to - The output directory for browser-bundled files.
+ * @property {ArrayableSetting} ignore - Module names or file paths which resolve to an empty object ({}) in the
+ * bundle instead of their real contents. For a dependency which is only reached because it is the default value of
+ * an option you always override (for example a selector engine's default DOM adapter, when you always pass your
+ * own), this keeps it (and anything only it requires) out of the bundle, as long as your code never actually reaches
+ * the real module by not overriding that option. See browserify's b.ignore(file).
+ * @property {ArrayableSetting} exclude - Module names or file paths left out of the bundle entirely; requiring one at
+ * runtime throws unless something else provides it (for example a script tag loading it separately). See
+ * browserify's b.exclude(file).
  */
 /**
  * Configurations for building the node distribution files.
@@ -83,6 +91,18 @@ import { fileExists } from 'test-filesystem'
  * @property {StringSetting} template - The file which will be pre-fixed to your README.md output.
  * @property {StringSetting} to - The directory to output the readme file in.
  */
+/**
+ * Configurations for generating the HTML documentation of a TypeScript project (with TypeDoc, from the source).
+ * @typedef {Object<string, Setting>} module:gulpConfig~DocsConfig
+ * @property {BooleanSetting} enabled - Toggle generating the documentation from the TypeScript source. When it is on the
+ * build does this instead of generating the readme from the jsdoc comments of the compiled files.
+ * @property {StringSetting} from - The directory holding the TypeScript source, each folder in it becomes a module.
+ * @property {StringSetting} index - The markdown file used as the front page of the documentation.
+ * @property {StringSetting} logLevel - How much TypeDoc reports: Verbose, Info, Warn, Error or None.
+ * @property {StringSetting} title - The name of the documentation, defaults to the name in the package.json.
+ * @property {StringSetting} to - The directory to generate the documentation in (it is cleared first).
+ * @property {FlagStringSetting} tsconfig - The tsconfig file to read the source with, defaults to the one of typescript.config.
+ */
 /**
  * Configurations to compile and copy the sass files into css.
  * @typedef {Object<string, Setting>} module:gulpConfig~SassConfig
@@ -113,6 +133,7 @@ import { fileExists } from 'test-filesystem'
  * @property {BrowserConfig} browser - Browser bundling configuration group.
  * @property {ArrayableSetting} cleanPaths - The paths for directories to delete before build.
  * @property {DistConfig} dist - Distribution file generation configuration group.
+ * @property {DocsConfig} docs - Generate the documentation of a TypeScript project configuration group.
  * @property {FontConfig} fonts - Fonts copy configuration group.
  * @property {ImageConfig} images - Minify and copy the images configuration.
  * @property {ReadmeConfig} readme - Build readme files configuration.
@@ -130,7 +151,9 @@ import { readFileSync } from 'fs'
 const setDefaults = {
   browser: {
     enabled: true,
+    exclude: [],
     from: 'dist/**/*.js',
+    ignore: [],
     name: 'default',
     to: 'browser',
   },
@@ -140,6 +163,15 @@ const setDefaults = {
     main: 'dist/main',
     to: 'dist',
   },
+  docs: {
+    enabled: false,
+    from: 'src',
+    index: 'MAIN.md',
+    logLevel: 'Warn',
+    title: '',
+    to: 'docs',
+    tsconfig: false,
+  },
   fonts: {
     enabled: false,
     from: 'src/fonts/**/*',

package/gulpfile.base.js

@@ -23,6 +23,7 @@ const sass = require('./dist/sass.js')
 const testFull = require('./dist/testFull.js')
 const testHelpers = require('./dist/testHelpers.js')
 const testQuick = require('./dist/testQuick.js')
+const typeDocs = require('./dist/typeDocs.js')
 const typescript = require('./dist/typeScript')
 const watchFull = require('./dist/watchFull.js')
 const watchTest = require('./dist/watchTest.js')
@@ -34,6 +35,7 @@ module.exports = {
   bundleMinify,
   copyFonts,
   defaultCmd,
+  docs: typeDocs,
   dist,
   distLint,
   distMinify,

package/gulpfile.base.mjs

@@ -22,6 +22,7 @@ export { sass } from './functions/sass.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 { 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": "5.1.1",
+  "version": "5.3.0",
   "description": "Standardised build process with gulp.",
   "main": "gulpfile.base.js",
   "exports": {
@@ -52,9 +52,9 @@
     "@babel/preset-typescript": "^7.29.7",
     "@babel/runtime-corejs3": "^8.0.6",
     "autoprefixer": "^10.6.1",
-    "babel-jest": "^30.4.1",
+    "babel-jest": "^30.5.2",
     "browserify": "^17.0.1",
-    "core-js": "^3.49.0",
+    "core-js": "^3.50.0",
     "cssnano": "^6.1.2",
     "glob": "^13.0.6",
     "gulp": "^5.0.1",
@@ -63,27 +63,31 @@
     "gulp-postcss": "^10.0.0",
     "gulp-rename": "^2.1.0",
     "gulp-sass": "^6.0.1",
-    "gulp-ts-compile": "^1.0.0",
+    "gulp-ts-compile": "^1.0.1",
     "gulp-uglify-es": "^3.0.0",
     "jest": "^30.5.2",
-    "jest-environment-jsdom": "^30.4.1",
+    "jest-environment-jsdom": "^30.5.2",
     "jsdoc-to-markdown": "^9.1.3",
     "postcss": "^8.5.28",
     "regenerator-runtime": "^0.14.1",
-    "sass": "^1.101.0",
+    "sass": "^1.105.0",
     "standard": "^17.1.2",
-    "test-filesystem": "^1.5.0",
+    "test-filesystem": "^1.5.1",
     "through2": "^4.0.2",
     "vinyl-source-stream": "^2.0.0"
   },
   "peerDependencies": {
     "gulp-imagemin": ">=9.0.0",
+    "typedoc": ">=0.28.0",
     "typescript": ">=5.0.0 <7.0.0"
   },
   "peerDependenciesMeta": {
     "gulp-imagemin": {
       "optional": true
     },
+    "typedoc": {
+      "optional": true
+    },
     "typescript": {
       "optional": true
     }
@@ -101,6 +105,7 @@
   "funding": "https://www.paypal.com/donate/?business=LRYR6SZRWKXVY&no_recurring=0&item_name=Let%27s+build+together+today+to+simplify+our+jobs+tomorrow.&currency_code=CAD",
   "devDependencies": {
     "gulp-imagemin": "github:jheagle/gulp-imagemin#common-js-compatibility",
+    "typedoc": "^0.28.20",
     "typescript": "^6.0.3"
   }
 }