js-build-tools 6.2.0 → 6.3.0

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 (59) hide show
  1. package/README.md +180 -9
  2. package/dist/build.js +2 -4
  3. package/dist/build.min.js +1 -1
  4. package/dist/bundle.js +1 -1
  5. package/dist/docs.js +19 -0
  6. package/dist/docs.min.js +1 -0
  7. package/dist/partials/jsdocDocsFor.js +31 -13
  8. package/dist/partials/loadPlaywright.js +34 -0
  9. package/dist/partials/neostandardLint.js +5 -3
  10. package/dist/partials/resolveDocsMethod.js +19 -0
  11. package/dist/partials/serveStatic.js +57 -0
  12. package/dist/partials/tsFor.js +2 -2
  13. package/dist/partials/typeDocsFor.js +28 -22
  14. package/dist/partials.js +34 -0
  15. package/dist/partials.min.js +1 -1
  16. package/dist/test-helpers/setUp.js +6 -0
  17. package/dist/utilities/convertMjsFilesForDocs.js +1 -0
  18. package/dist/utilities/dotGet.js +1 -0
  19. package/dist/utilities/dotNotate.js +5 -0
  20. package/dist/utilities/dotSet.js +1 -0
  21. package/dist/utilities/esmNamedExportsToCjs.js +1 -0
  22. package/dist/utilities/getBundleConfigs.js +1 -0
  23. package/dist/utilities/isObject.js +1 -0
  24. package/dist/utilities/strAfter.js +1 -0
  25. package/dist/utilities/strBefore.js +1 -0
  26. package/functions/build.mjs +2 -4
  27. package/functions/bundle.mjs +1 -1
  28. package/functions/docs.mjs +13 -0
  29. package/functions/docs.test.mjs +45 -0
  30. package/functions/jsdocEsmExports.test.mjs +24 -0
  31. package/functions/partials/jsdocDocsFor.mjs +25 -13
  32. package/functions/partials/jsdocDocsFor.test.mjs +48 -0
  33. package/functions/partials/loadPlaywright.mjs +23 -0
  34. package/functions/partials/loadPlaywright.test.mjs +71 -0
  35. package/functions/partials/neostandardLint.mjs +5 -3
  36. package/functions/partials/resolveDocsMethod.mjs +10 -0
  37. package/functions/partials/resolveDocsMethod.test.mjs +33 -0
  38. package/functions/partials/serveStatic.mjs +47 -0
  39. package/functions/partials/serveStatic.test.mjs +71 -0
  40. package/functions/partials/tsFor.mjs +2 -2
  41. package/functions/partials/typeDocsFor.mjs +24 -20
  42. package/functions/partials/typeDocsFor.test.mjs +23 -0
  43. package/functions/partials.mjs +4 -0
  44. package/functions/partials.test.mjs +1 -1
  45. package/functions/test-helpers/setUp.mjs +6 -0
  46. package/functions/utilities/convertMjsFilesForDocs.mjs +1 -0
  47. package/functions/utilities/dotGet.mjs +1 -0
  48. package/functions/utilities/dotNotate.mjs +5 -0
  49. package/functions/utilities/dotSet.mjs +1 -0
  50. package/functions/utilities/esmNamedExportsToCjs.mjs +1 -0
  51. package/functions/utilities/getBundleConfigs.mjs +1 -0
  52. package/functions/utilities/isObject.mjs +1 -0
  53. package/functions/utilities/strAfter.mjs +1 -0
  54. package/functions/utilities/strBefore.mjs +1 -0
  55. package/gulp.config.mjs +2 -2
  56. package/gulpfile.base.mjs +3 -4
  57. package/jsdoc.base.js +9 -3
  58. package/jsdoc.esmExports.js +17 -0
  59. package/package.json +19 -10
@@ -0,0 +1,17 @@
1
+ /**
2
+ * A jsdoc plugin for ES module source. When a file has no @module tag of its own, jsdoc names each
3
+ * `export const x` it documents `exports.x`, so with `@memberOf module:name` it becomes `module:name.exports.x`
4
+ * (shown as "exports.x"). This drops that `exports.` so it is `module:name.x`, the name it is used by.
5
+ */
6
+ const prefix = 'exports.'
7
+
8
+ exports.handlers = {
9
+ newDoclet ({ doclet }) {
10
+ if (doclet.name && doclet.name.startsWith(prefix)) {
11
+ doclet.name = doclet.name.slice(prefix.length)
12
+ }
13
+ if (doclet.longname && doclet.longname.includes(`.${prefix}`)) {
14
+ doclet.longname = doclet.longname.replace(`.${prefix}`, '.')
15
+ }
16
+ }
17
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "js-build-tools",
3
- "version": "6.2.0",
3
+ "version": "6.3.0",
4
4
  "description": "Standardised build process with gulp.",
5
5
  "main": "gulpfile.base.js",
6
6
  "exports": {
@@ -20,8 +20,10 @@
20
20
  "scripts": {
21
21
  "build": "gulp build",
22
22
  "dev": "gulp",
23
- "htmldocs": "jsdoc -R MAIN.md -c ./.jsdoc.conf.js -d docs",
23
+ "docs": "gulp docs",
24
24
  "readme": "gulp readme",
25
+ "release": "release-it",
26
+ "release:dry-run": "release-it --dry-run",
25
27
  "test": "gulp testFull",
26
28
  "test:quick": "gulp testQuick",
27
29
  "watch": "gulp watchFull",
@@ -54,9 +56,9 @@
54
56
  "autoprefixer": "^10.6.1",
55
57
  "babel-jest": "^30.5.2",
56
58
  "browserify": "^17.0.1",
57
- "core-js": "^3.50.0",
59
+ "core-js": "^3.51.0",
58
60
  "cssnano": "^6.1.2",
59
- "eslint": "^10.12.0",
61
+ "eslint": "^10.13.0",
60
62
  "glob": "^13.0.6",
61
63
  "gulp": "^5.0.1",
62
64
  "gulp-babel": "^8.1.0",
@@ -64,17 +66,17 @@
64
66
  "gulp-postcss": "^10.0.0",
65
67
  "gulp-rename": "^2.1.0",
66
68
  "gulp-sass": "^6.0.1",
67
- "gulp-ts-compile": "^1.0.1",
69
+ "gulp-ts-compile": "^1.0.2",
68
70
  "gulp-uglify-es": "^3.0.0",
69
71
  "jest": "^30.5.2",
70
72
  "jest-environment-jsdom": "^30.5.2",
71
73
  "jsdoc-to-markdown": "^9.1.3",
72
74
  "merge-stream": "^2.0.0",
73
75
  "neostandard": "^0.14.1",
74
- "postcss": "^8.5.30",
76
+ "postcss": "^8.5.31",
75
77
  "regenerator-runtime": "^0.14.1",
76
- "sass": "^1.105.1",
77
- "test-filesystem": "^2.0.0",
78
+ "sass": "^1.105.2",
79
+ "test-filesystem": "^2.0.2",
78
80
  "through2": "^4.0.2",
79
81
  "vinyl-source-stream": "^2.0.0"
80
82
  },
@@ -82,6 +84,7 @@
82
84
  "clean-jsdoc-theme": ">=4.0.0",
83
85
  "gulp-imagemin": ">=9.0.0",
84
86
  "jsdoc": ">=4.0.0",
87
+ "playwright": ">=1.40.0",
85
88
  "typedoc": ">=0.28.0",
86
89
  "typescript": ">=5.0.0 <7.0.0"
87
90
  },
@@ -95,6 +98,9 @@
95
98
  "jsdoc": {
96
99
  "optional": true
97
100
  },
101
+ "playwright": {
102
+ "optional": true
103
+ },
98
104
  "typedoc": {
99
105
  "optional": true
100
106
  },
@@ -110,13 +116,16 @@
110
116
  "gulpfile.base.mjs",
111
117
  "gulp.config.js",
112
118
  "gulp.config.mjs",
113
- "jsdoc.base.js"
119
+ "jsdoc.base.js",
120
+ "jsdoc.esmExports.js"
114
121
  ],
115
122
  "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",
116
123
  "devDependencies": {
117
- "clean-jsdoc-theme": "^5.2.0",
124
+ "clean-jsdoc-theme": "^4.3.3",
118
125
  "gulp-imagemin": "github:jheagle/gulp-imagemin#common-js-compatibility",
119
126
  "jsdoc": "^4.0.5",
127
+ "playwright": "~1.62.1",
128
+ "release-it": "^21.1.1",
120
129
  "typedoc": "^0.28.20",
121
130
  "typescript": "^6.0.3"
122
131
  },