js-build-tools 6.2.2 → 6.3.1

package/jsdoc.base.js

@@ -1,10 +1,16 @@
+const path = require('path')
 const gulpConfig = require('./gulp.config.js')
 
 module.exports = {
-  plugins: ['plugins/markdown'],
+  plugins: ['plugins/markdown', path.join(__dirname, 'jsdoc.esmExports.js')],
+  // Give markdown headings ids (the README / docs.index front page), so they can be linked to and a theme's
+  // table of contents can follow them
+  markdown: { idInHeadings: true },
   source: {
     include: [gulpConfig.get('dist.to')],
-    includePattern: '.+\\.js(doc|x)?$',
-    excludePattern: '((^|\\/|\\\\)_|.+\\.test\\..*)'
+    // .mjs / .cjs too, so ES module source can be documented as it is, not only its compiled CommonJS
+    includePattern: '.+\\.[cm]?js(doc|x)?$',
+    // Files starting with _, tests, and minified copies (which only repeat what their unminified file documents)
+    excludePattern: '((^|\\/|\\\\)_|.+\\.test\\..*|.+\\.min\\.[cm]?js$)'
   },
 }

package/jsdoc.esmExports.js

@@ -0,0 +1,17 @@
+/**
+ * A jsdoc plugin for ES module source. When a file has no @module tag of its own, jsdoc names each
+ * `export const x` it documents `exports.x`, so with `@memberOf module:name` it becomes `module:name.exports.x`
+ * (shown as "exports.x"). This drops that `exports.` so it is `module:name.x`, the name it is used by.
+ */
+const prefix = 'exports.'
+
+exports.handlers = {
+  newDoclet ({ doclet }) {
+    if (doclet.name && doclet.name.startsWith(prefix)) {
+      doclet.name = doclet.name.slice(prefix.length)
+    }
+    if (doclet.longname && doclet.longname.includes(`.${prefix}`)) {
+      doclet.longname = doclet.longname.replace(`.${prefix}`, '.')
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "js-build-tools",
-  "version": "6.2.2",
+  "version": "6.3.1",
   "description": "Standardised build process with gulp.",
   "main": "gulpfile.base.js",
   "exports": {
@@ -20,7 +20,7 @@
   "scripts": {
     "build": "gulp build",
     "dev": "gulp",
-    "htmldocs": "jsdoc -R MAIN.md -c ./.jsdoc.conf.js -d docs",
+    "docs": "gulp docs",
     "readme": "gulp readme",
     "release": "release-it",
     "release:dry-run": "release-it --dry-run",
@@ -56,9 +56,9 @@
     "autoprefixer": "^10.6.1",
     "babel-jest": "^30.5.2",
     "browserify": "^17.0.1",
-    "core-js": "^3.50.0",
+    "core-js": "^3.51.0",
     "cssnano": "^6.1.2",
-    "eslint": "^10.12.0",
+    "eslint": "^10.13.0",
     "glob": "^13.0.6",
     "gulp": "^5.0.1",
     "gulp-babel": "^8.1.0",
@@ -66,17 +66,17 @@
     "gulp-postcss": "^10.0.0",
     "gulp-rename": "^2.1.0",
     "gulp-sass": "^6.0.1",
-    "gulp-ts-compile": "^1.0.1",
+    "gulp-ts-compile": "^1.0.2",
     "gulp-uglify-es": "^3.0.0",
     "jest": "^30.5.2",
     "jest-environment-jsdom": "^30.5.2",
     "jsdoc-to-markdown": "^9.1.3",
     "merge-stream": "^2.0.0",
     "neostandard": "^0.14.1",
-    "postcss": "^8.5.30",
+    "postcss": "^8.5.31",
     "regenerator-runtime": "^0.14.1",
-    "sass": "^1.105.1",
-    "test-filesystem": "^2.0.0",
+    "sass": "^1.105.2",
+    "test-filesystem": "^2.0.2",
     "through2": "^4.0.2",
     "vinyl-source-stream": "^2.0.0"
   },
@@ -84,6 +84,7 @@
     "clean-jsdoc-theme": ">=4.0.0",
     "gulp-imagemin": ">=9.0.0",
     "jsdoc": ">=4.0.0",
+    "playwright": ">=1.40.0",
     "typedoc": ">=0.28.0",
     "typescript": ">=5.0.0 <7.0.0"
   },
@@ -97,6 +98,9 @@
     "jsdoc": {
       "optional": true
     },
+    "playwright": {
+      "optional": true
+    },
     "typedoc": {
       "optional": true
     },
@@ -112,13 +116,15 @@
     "gulpfile.base.mjs",
     "gulp.config.js",
     "gulp.config.mjs",
-    "jsdoc.base.js"
+    "jsdoc.base.js",
+    "jsdoc.esmExports.js"
   ],
   "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": {
-    "clean-jsdoc-theme": "^5.2.0",
+    "clean-jsdoc-theme": "^4.3.3",
     "gulp-imagemin": "github:jheagle/gulp-imagemin#common-js-compatibility",
     "jsdoc": "^4.0.5",
+    "playwright": "~1.62.1",
     "release-it": "^21.1.1",
     "typedoc": "^0.28.20",
     "typescript": "^6.0.3"