@vamship/build-utils 1.5.3 → 2.0.0-1

package/package.json

@@ -1,17 +1,22 @@
 {
     "name": "@vamship/build-utils",
-    "version": "1.5.3",
+    "version": "2.0.0-1",
     "description": "Utility library for build tooling",
+    "type": "module",
     "main": "src/index.js",
     "scripts": {
-        "clean": "rm -rf .nyc_output coverage",
-        "monitor": "nodemon --exec npm run test",
-        "test": "nyc mocha -R spec --recursive test/unit/ && nyc report --reporter=html",
+        "clean": "rm -rf .nyc_output .coverage",
+        "watch:test": "NODE_OPTIONS=\"--experimental-vm-modules\" c8 mocha --watch",
+        "test": "NODE_OPTIONS=\"--experimental-vm-modules\" c8 mocha",
         "lint": "eslint src/**/*.js test/**/*.js",
         "format": "prettier --write \"{{src,test}/**/*.js,README.md}\"",
         "docs": "jsdoc --readme README.md --package package.json --template node_modules/docdash --destination docs --recurse src",
         "all": "npm run format && npm run lint && npm run test && npm run clean"
     },
+    "engines": {
+        "node": ">= 20.11.0",
+        "npm": ">= 10.2.4"
+    },
     "files": [
         "package.json",
         "LICENSE",
@@ -41,67 +46,51 @@
     },
     "homepage": "https://github.com/vamship/build-utils#readme",
     "devDependencies": {
-        "chai": "^4.3.7",
-        "chai-as-promised": "^7.1.1",
-        "eslint": "^8.40.0",
-        "jsdoc": "^4.0.2",
-        "mocha": "^10.2.0",
-        "nodemon": "^2.0.22",
-        "nyc": "^15.1.0",
-        "prettier": "^2.8.8",
-        "rewire": "^6.0.0",
-        "sinon": "^15.0.4",
+        "c8": "^9.1.0",
+        "chai": "^4.4.1",
+        "dot-prop": "^8.0.2",
+        "eslint": "^8.56.0",
+        "esmock": "^2.6.5",
+        "gulp-eslint-new": "^2.0.0",
+        "jsdoc": "^4.0.3",
+        "mocha": "^10.4.0",
+        "nodemon": "^3.1.0",
+        "prettier": "^3.2.5",
+        "rewire": "^7.0.0",
+        "sinon": "^17.0.2",
         "sinon-chai": "^3.7.0"
     },
     "dependencies": {
-        "camelcase": "^6.3.0",
+        "ajv": "^8.13.0",
+        "ansi-colors": "^4.1.3",
+        "change-case": "^5.4.4",
         "delete": "^1.1.0",
-        "docdash": "^2.0.1",
-        "dotenv": "^16.0.3",
-        "dotenv-expand": "^10.0.0",
-        "execa": "^5.1.1",
-        "fancy-log": "^2.0.0",
+        "docdash": "^2.0.2",
+        "dotenv": "^16.4.5",
+        "dotenv-expand": "^11.0.6",
+        "execa": "^9.0.1",
+        "fancy-log": ">=2.0.0",
         "mkdirp": "^3.0.1",
-        "semver": "^7.5.0"
+        "semver": "^7.6.2"
     },
     "peerDependencies": {
         "@typescript-eslint/eslint-plugin": ">= 5.1.0",
         "@typescript-eslint/parser": ">= 5.1.0",
-        "eslint": ">= 7.32.0",
-        "fancy-log": ">= 1.3.3",
+        "c8": ">= 7.12.0",
+        "eslint": ">= 8.56.0",
+        "fancy-log": ">=2.0.0",
         "gulp": ">= 4.0.2",
-        "gulp-eslint": ">= 6.0.0",
         "gulp-prettier": ">= 4.0.0",
-        "gulp-typedoc": ">= 3.0.1",
         "gulp-typescript": ">= 5.0.1",
         "gulp-zip": ">= 5.1.0",
-        "jsdoc": ">= 4.0.2",
-        "mocha": ">= 10.2.0",
-        "nyc": ">= 15.1.0",
-        "prettier": ">= 2.8.8"
-    },
-    "peerDependenciesMeta": {
-        "gulp-eslint": {
-            "optional": true
-        },
-        "gulp-typedoc": {
-            "optional": true
-        },
-        "gulp-typescript": {
-            "optional": true
-        }
+        "jsdoc": ">= 3.6.7",
+        "mocha": ">= 9.1.2",
+        "prettier": ">= 2.4.1",
+        "typedoc": ">= 0.24.8"
     },
     "optionalDependencies": {
-        "typedoc": ">=0.24.7",
-        "typescript": ">=5.0.4"
-    },
-    "overrides": {
-        "glob-parent": "^6.0.2",
-        "jsdoc": "^4.0.2",
-        "sanitize-html": "^2.10.0"
-    },
-    "engines": {
-        "node": ">= 14.18.1",
-        "npm": ">= 8.1.0"
+        "gulp-jsdoc3": "= 3.0.0",
+        "typedoc": ">=0.25.13",
+        "typescript": ">=5.4.5"
     }
 }

package/src/directory.js

@@ -1,6 +1,4 @@
-'use strict';
-
-const _path = require('path');
+import _path from 'path';
 
 const _sepRegexp = new RegExp(_path.sep.replace(/\\/g, '\\\\'), 'g');
 
@@ -8,13 +6,13 @@ const _sepRegexp = new RegExp(_path.sep.replace(/\\/g, '\\\\'), 'g');
  * Abstract representation of a directory, with methods for traversal and
  * glob pattern generation.
  */
-class Directory {
+export class Directory {
     /**
      * @param {String} path The path represented by this directory.
      */
     constructor(path) {
         if (typeof path !== 'string') {
-            throw new Error('Invalid path specified (arg #1)');
+            throw new Error('Invalid path (arg #1)');
         }
 
         let relativePath = path.replace(process.cwd(), '');
@@ -39,10 +37,10 @@ class Directory {
      */
     static createTree(rootPath, tree) {
         if (typeof rootPath !== 'string') {
-            throw new Error('Invalid rootPath specified (arg #1)');
+            throw new Error('Invalid rootPath (arg #1)');
         }
         if (!tree || tree instanceof Array || typeof tree !== 'object') {
-            throw new Error('Invalid tree specified (arg #2)');
+            throw new Error('Invalid tree (arg #2)');
         }
 
         function createRecursive(parent, tree) {
@@ -72,10 +70,10 @@ class Directory {
      */
     static traverseTree(root, callback) {
         if (!(root instanceof Directory)) {
-            throw new Error('Invalid root directory specified (arg #1)');
+            throw new Error('Invalid root directory (arg #1)');
         }
         if (typeof callback !== 'function') {
-            throw new Error('Invalid callback function specified (arg #1)');
+            throw new Error('Invalid callback function (arg #2)');
         }
         function traverseRecursive(parent, level) {
             callback(parent, level);
@@ -129,11 +127,11 @@ class Directory {
      */
     addChild(name) {
         if (typeof name !== 'string' || name.length <= 0) {
-            throw new Error('Invalid directory name specified (arg #1)');
+            throw new Error('Invalid directory name (arg #1)');
         }
         if (name.match(/[\\/:]/)) {
             throw new Error(
-                'Directory name cannot include path separators (:, \\ or /)'
+                'Directory name cannot include path separators (:, \\ or /)',
             );
         }
         const child = new Directory(_path.join(this.path, name));
@@ -142,6 +140,16 @@ class Directory {
         return child;
     }
 
+    /**
+     * Returns an array containing all first level children of the current
+     * directory.
+     *
+     * @return {Directory[]} An array of first level children for the directory.
+     */
+    getChildren() {
+        return this._children.slice();
+    }
+
     /**
      * Retrieves a child directory object by recursively searching through the
      * current directory's child tree.
@@ -154,7 +162,7 @@ class Directory {
      */
     getChild(path) {
         if (typeof path !== 'string' || path.length <= 0) {
-            throw new Error('Invalid child path specified (arg #1)');
+            throw new Error('Invalid childPath (arg #1)');
         }
         const tokens = path.split('/');
         const child = tokens.reduce((result, name) => {
@@ -171,16 +179,6 @@ class Directory {
         return child;
     }
 
-    /**
-     * Returns an array containing all first level children of the current
-     * directory.
-     *
-     * @return {Directory[]} An array of first level children for the directory.
-     */
-    getChildren() {
-        return this._children.slice();
-    }
-
     /**
      * Returns the path to a file within the current directory. This file
      * does not have to actually exist on the file system, and can also be the
@@ -229,6 +227,20 @@ class Directory {
         }
         return `${this.globPath}**/${extension}`;
     }
+    /**
+     * Gets a string glob that can be used to match all folders/files
+     * starting with .(dot) in the current folder and all sub folders,
+     * optionally filtered by file extension.
+     *
+     * @param {String} [extension] An optional extension to use when generating
+     *        a globbing pattern.
+     */
+    getAllHiddenFilesGlob(extension) {
+        if (typeof extension !== 'string') {
+            extension = '.*';
+        } else {
+            extension = `.*.${extension}`;
+        }
+        return `${this.globPath}**/${extension}`;
+    }
 }
-
-module.exports = Directory;

package/src/index.js

@@ -3,20 +3,8 @@
 /**
  * Utility library that can be used to create development tooling.
  */
-module.exports = {
-    /**
-     * A class that represents a directory on the file system.
-     */
-    Directory: require('./directory'),
-
-    /**
-     * Represents a specific project configuration.
-     */
-    Project: require('./project'),
-
-    /**
-     * A collection of task builder functions that can be used to generate
-     * commonly used gulp files for projects.
-     */
-    taskBuilders: require('./task-builders'),
-};
+export * from './directory.js';
+export * from './project.js';
+export * from './task-builders/index.js';
+export * from './task-factories/index.js';
+export { getTaskFactory } from './utils/task-factory-utils.js';