watchful-cli 1.7.35 → 1.7.38

package/README.md

@@ -2,7 +2,7 @@
 
 Incremental transpilation with bundling.
 
-Watchful leverages existing bundlers and transpilers in order to provide a straightforward build tool that supports incremental transpilation together with bundling. It has a batch mode and a watch mode. In the latter mode it will only transpile files that have been added or changed, improving build times considerably.
+Watchful leverages existing bundlers and transpilers in order to provide a straightforward build tool that supports incremental  transpilation with bundling. It has a batch mode and a watch mode. In the latter mode it will only transpile files that have been added or changed, improving build times considerably.
 
 Watchful works best hand in hand with [Lively-CLI](https://github.com/djalbat/lively-cli).
 
@@ -26,10 +26,6 @@ Both of these packages work in the browser and on Node. Necessary accomplishes t
 
 This is also a package but has a bundled example. To see the latter in action, run `npm install` and `npm watch-debug` as before along with `npm start` to kick off a small development server. The example can be viewed at http://localhost:8888 and, since the development server utilises Lively, will live reload if you make changes to the source.
 
-* [Muon](https://github.com/petros-ioannou1/muon)
-
-Muon is a work in progress but nonetheless is a good example of a project that leverages both Watchful and Lively. The setup instructions are the same as for With Style.
-
 ### Comparisons
 
 Using SWC and ESBuild in combination together with multiple processes can speed up a batch build more than fifteen times. The following metrics were gathered on a modern albeit mid-level MacBook for a project with just under four hundred files:
@@ -39,12 +35,6 @@ Using SWC and ESBuild in combination together with multiple processes can speed
 | Babel + Browserify          | 8.5 seconds    | 2.2 seconds  | 10.7 seconds |
 | SWC + ESBuild (4 processes) | 0.42 seconds   | 0.24 seconds | 0.66 seconds |
 
-### Why aren't these tools included as dependencies?
-
-Babel presets and plugins require [@babel/core](https://babeljs.io/docs/en/babel-core) as a peer dependency, so you would have to include it in your project anyway. Additionally, it is a large project with many dependencies itself and since it is optional, it did not seem like a good idea to include it. Similarly, since bundling is optional, there seemed little point in including either bundler as a dependency. 
-
-Watchful is designed to run in your project directory and will load the bundlers and transpilers it finds there. This gives you complete control over their versions and configuration. Aside from a `debug` and `node` options, Watchful is agnostic to both.  
-
 ## Installation
 
 You can install Watchful via [npm](https://www.npmjs.com/):
@@ -80,22 +70,24 @@ Commands:
   
 Options:
 
-  --help|-h                                      Show this help
-  
   --version|-v                                   Show the version
 
+  --help|-h                                      Show this help
+  
   --wait|-w                                      Wait before building incrementally
 
   --node|-n                                      Bundle for Node rather than the browser
 
   --debug|-d                                     Debug, that is enable source maps
   
+  --release|-r                                   Release, that is enable minification
+  
   --metrics|-m                                   Show metrics, that is file counts and times
 
   --quietly|-q                                   Run with almost no console logging
 
   --processes|-p                                 The number of processes
-
+  
   --bundler|-u                                   The bundler, either `browserify` or `esbuild`
 
   --transpiler|-r                                The transpiler, either `babel` or `swc`
@@ -104,9 +96,9 @@ Options:
   
   --bundle-file|-b                               Bundle file path
   
-  --lib-directory|-l                             Lib directory path
+  --lib-directory|-l                             Library directory path
 
-  --temp-directory|-t                            Temp directory path
+  --temp-directory|-x                            Temporary directory path
 
   --source-directory|-s                          Source directory path
 ```
@@ -199,11 +191,11 @@ Now for the npm scripts:
 ```
 "scripts": {
   "clean": "rm -rf ./tmp",
-  "watchful": "watchful -m -s=./es6 -t=./tmp -e=main.js -b=./public/lib/client.js",
-  "batch": "npm run watchful batch --",
+  "watchful": "watchful -m -s=./es6 -x=./tmp -e=main.js -b=./public/lib/client.js--wait=100 ",
+  "batch": "npm run watchful batch -- --release",
   "batch-debug": "npm run watchful batch -- --debug",
-  "incremental": "npm run watchful incremental -- -qm --wait=100",
-  "incremental-debug": "npm run watchful incremental -- --debug -qm --wait=100",
+  "incremental": "npm run watchful incremental -- --release",
+  "incremental-debug": "npm run watchful incremental -- --debug",
   "build": "npm run clean && npm run batch && npm run clean",
   "build-debug": "npm run clean && npm run batch-debug && npm run clean",
   "watch": "npm run clean && npm run batch && npm run incremental",
@@ -229,7 +221,7 @@ The number of child processes has also been set to 4 here, but remember that thi
 
 * For a package rather than a bundle, you could remove the call to the final `clean` script from the build scripts; remove the entry and bundle file options from the `watchful` script; and change the temp directory to a lib directory.
 
-* For incremental builds, the `wait` option has been set to 100 milliseconds. Usually this can be left at the default, which is 0 milliseconds. However, if you find that not all of the transformations are being completed before bundling starts, you may want to experiment with this option.
+* The `wait` option has been set to 100 milliseconds. Usually this can be left at the default, which is 0 milliseconds. However, if you find that not all of the transformations are being completed before bundling starts, you may want to experiment with this option.
  
 ## Contact
 

package/bin/abbreviations.js

@@ -4,6 +4,7 @@ const { HELP_OPTION,
         NODE_OPTION,
         WAIT_OPTION,
         DEBUG_OPTION,
+        RELEASE_OPTION,
         BUNDLER_OPTION,
         QUIETLY_OPTION,
         VERSION_OPTION,
@@ -20,16 +21,17 @@ const h = HELP_OPTION,
       n = NODE_OPTION,
       w = WAIT_OPTION,
       d = DEBUG_OPTION,
+      r = RELEASE_OPTION,
       u = BUNDLER_OPTION,
       q = QUIETLY_OPTION,
       v = VERSION_OPTION,
       m = METRICS_OPTION,
       p = PROCESSES_OPTION,
-      r = TRANSPILER_OPTION,
+      t = TRANSPILER_OPTION,
       e = ENTRY_FILE_OPTION,
       b = BUNDLE_FILE_OPTION,
       l = LIB_DIRECTORY_OPTION,
-      t = TEMP_DIRECTORY_OPTION,
+      x = TEMP_DIRECTORY_OPTION,
       s = SOURCE_DIRECTORY_OPTION;
 
 module.exports = {
@@ -37,15 +39,16 @@ module.exports = {
   n,
   w,
   d,
+  r,
   u,
   q,
   v,
   m,
   p,
-  r,
+  t,
   e,
   b,
   l,
-  t,
+  x,
   s
 };

package/bin/action/batch.js

@@ -10,7 +10,7 @@ const action = require("../action"),
 
 const { BATCH_BUILD_FAILED_MESSAGE } = require("../messages");
 
-function batchAction(wait, node, debug, bundler, quietly, metrics, entryFile, processes, transpiler, bundleFile, libDirectory, tempDirectory, sourceDirectory) {
+function batchAction(wait, node, debug, release, bundler, quietly, metrics, entryFile, processes, transpiler, bundleFile, libDirectory, tempDirectory, sourceDirectory) {
   const operations = [
           initialiseOperation,
           createTranspileFileFunctionOperation,
@@ -23,6 +23,7 @@ function batchAction(wait, node, debug, bundler, quietly, metrics, entryFile, pr
           wait,
           node,
           debug,
+          release,
           bundler,
           quietly,
           metrics,

package/bin/action/help.js

@@ -27,6 +27,8 @@ Options:
 
   --debug|-d                                     Debug, that is enable source maps
   
+  --release|-r                                   Release, that is enable minification
+  
   --metrics|-m                                   Show metrics, that is file counts and times
 
   --quietly|-q                                   Run with almost no console logging
@@ -41,9 +43,9 @@ Options:
   
   --bundle-file|-b                               Bundle file path
   
-  --lib-directory|-l                             Lib directory path
+  --lib-directory|-l                             Library directory path
 
-  --temp-directory|-t                            Temp directory path
+  --temp-directory|-x                            Temporary directory path
 
   --source-directory|-s                          Source directory path
 

package/bin/action/incremental.js

@@ -9,7 +9,7 @@ const watch = require("../watch"),
 
 const { INCREMENTAL_BUILD_FAILED_MESSAGE } = require("../messages");
 
-function incrementalAction(wait, node, debug, bundler, quietly, metrics, entryFile, processes, transpiler, bundleFile, libDirectory, tempDirectory, sourceDirectory) {
+function incrementalAction(wait, node, debug, release, bundler, quietly, metrics, entryFile, processes, transpiler, bundleFile, libDirectory, tempDirectory, sourceDirectory) {
   const operations = [
           initialiseOperation,
           createTranspileFileFunctionOperation,
@@ -20,6 +20,7 @@ function incrementalAction(wait, node, debug, bundler, quietly, metrics, entryFi
           wait,
           node,
           debug,
+          release,
           bundler,
           quietly,
           metrics,

package/bin/actions.js

@@ -10,8 +10,9 @@ const { HELP_COMMAND, BATCH_COMMAND, VERSION_COMMAND, INCREMENTAL_COMMAND } = re
         DEFAULT_WAIT,
         DEFAULT_NODE,
         DEFAULT_DEBUG,
-        DEFAULT_VERSION,
+        DEFAULT_RELEASE,
         DEFAULT_BUNDLER,
+        DEFAULT_VERSION,
         DEFAULT_QUIETLY,
         DEFAULT_METRICS,
         DEFAULT_ENTRY_FILE,
@@ -28,8 +29,9 @@ function actions(command, argument, options) {
           wait = DEFAULT_WAIT,
           node = DEFAULT_NODE,
           debug = DEFAULT_DEBUG,
-          version = DEFAULT_VERSION,
+          release = DEFAULT_RELEASE,
           bundler = DEFAULT_BUNDLER,
+          version = DEFAULT_VERSION,
           quietly = DEFAULT_QUIETLY,
           metrics = DEFAULT_METRICS,
           entryFile = DEFAULT_ENTRY_FILE,
@@ -52,9 +54,9 @@ function actions(command, argument, options) {
 
   switch (command) {
     case HELP_COMMAND: helpAction(); break;
-    case BATCH_COMMAND: batchAction(wait, node, debug, bundler, quietly, metrics, entryFile, processes, transpiler, bundleFile, libDirectory, tempDirectory, sourceDirectory); break;
+    case BATCH_COMMAND: batchAction(wait, node, debug, release, bundler, quietly, metrics, entryFile, processes, transpiler, bundleFile, libDirectory, tempDirectory, sourceDirectory); break;
     case VERSION_COMMAND: versionAction(); break;
-    case INCREMENTAL_COMMAND: incrementalAction(wait, node, debug, bundler, quietly, metrics, entryFile, processes, transpiler, bundleFile, libDirectory, tempDirectory, sourceDirectory); break;
+    case INCREMENTAL_COMMAND: incrementalAction(wait, node, debug, release, bundler, quietly, metrics, entryFile, processes, transpiler, bundleFile, libDirectory, tempDirectory, sourceDirectory); break;
   }
 }
 

package/bin/defaults.js

@@ -6,8 +6,9 @@ const DEFAULT_HELP = false,
       DEFAULT_WAIT = 0,
       DEFAULT_NODE = false,
       DEFAULT_DEBUG = false,
-      DEFAULT_VERSION = false,
+      DEFAULT_RELEASE = false,
       DEFAULT_BUNDLER = BROWSERIFY,
+      DEFAULT_VERSION = false,
       DEFAULT_QUIETLY = false,
       DEFAULT_METRICS = false,
       DEFAULT_PROCESSES = 1,
@@ -23,8 +24,9 @@ module.exports = {
   DEFAULT_WAIT,
   DEFAULT_NODE,
   DEFAULT_DEBUG,
-  DEFAULT_VERSION,
+  DEFAULT_RELEASE,
   DEFAULT_BUNDLER,
+  DEFAULT_VERSION,
   DEFAULT_QUIETLY,
   DEFAULT_METRICS,
   DEFAULT_PROCESSES,

package/bin/messages.js

@@ -12,6 +12,7 @@ const SWC_FAILED_MESSAGE = "swc failed:",
       BROWSERIFY_NOT_INSTALLED_MESSAGE = "Browserify is not installed.",
       NO_ENTRY_FILE_SPECIFIED_MESSAGE = "If a temp directory is specified then an entry file must also be given.",
       NO_BUNDLE_FILE_SPECIFIED_MESSAGE = "If a temp directory is specified then a bundle file must also be given.",
+      DEBUG_AND_RELEAES_BOTH_SET_MESSAGE = "The debug and release flags cannot both be set at the same time.",
       NO_SOURCE_DIRECTORY_SPECIFIED_MESSAGE = "The source directory has not been specified.",
       ENTRY_FILE_BUT_NO_BUNDLE_FILE_SPECIFIED_MESSAGE = "If an entry file is specified then a bundle file must also be given.",
       BUNDLE_FILE_BUT_NO_ENTRY_FILE_SPECIFIED_MESSAGE = "If a bundle file is specified then an entry file must also be given.",
@@ -37,6 +38,7 @@ module.exports = {
   BROWSERIFY_NOT_INSTALLED_MESSAGE,
   NO_ENTRY_FILE_SPECIFIED_MESSAGE,
   NO_BUNDLE_FILE_SPECIFIED_MESSAGE,
+  DEBUG_AND_RELEAES_BOTH_SET_MESSAGE,
   NO_SOURCE_DIRECTORY_SPECIFIED_MESSAGE,
   ENTRY_FILE_BUT_NO_BUNDLE_FILE_SPECIFIED_MESSAGE,
   BUNDLE_FILE_BUT_NO_ENTRY_FILE_SPECIFIED_MESSAGE,

package/bin/operation/initialise.js

@@ -4,6 +4,7 @@ const { pathFromOption } = require("../utilities/path"),
       { initialiseMetrics } = require("../utilities/metrics"),
       { NO_ENTRY_FILE_SPECIFIED_MESSAGE,
         NO_BUNDLE_FILE_SPECIFIED_MESSAGE,
+        DEBUG_AND_RELEAES_BOTH_SET_MESSAGE,
         NO_SOURCE_DIRECTORY_SPECFIFIED_MESSAGE,
         ENTRY_FILE_BUT_NO_BUNDLE_FILE_SPECIFIED_MESSAGE,
         BUNDLE_FILE_BUT_NO_ENTRY_FILE_SPECIFIED_MESSAGE,
@@ -19,6 +20,7 @@ function initialiseOperation(proceed, abort, context) {
   const { wait,
           node,
           debug,
+          release,
           bundler,
           quietly,
           metrics,
@@ -36,6 +38,14 @@ function initialiseOperation(proceed, abort, context) {
       sourceDirectoryPath = null,
       targetDirectoryPath = null;
 
+  if (debug && release) {
+    console.log(DEBUG_AND_RELEAES_BOTH_SET_MESSAGE);
+
+    abort();
+
+    return;
+  }
+
   if (sourceDirectory === null) {
     console.log(NO_SOURCE_DIRECTORY_SPECFIFIED_MESSAGE);
 

package/bin/utilities/bundle.js

@@ -32,7 +32,7 @@ function createEsbuildBundleFilesFunction(context) {
           esbuild = require(esbuildPath);
 
     esBuildBundleFilesFunction = (entryFilePath, bundleFilePath, targetDirectoryPath, callback) => {
-      const { node, debug } = context,
+      const { node, debug, release } = context,
             bundler = esbuild,  ///
             targetEntryFilePath = combinePaths(targetDirectoryPath, entryFilePath),
             entryPoint = targetEntryFilePath, ///
@@ -41,10 +41,12 @@ function createEsbuildBundleFilesFunction(context) {
             ],
             outfile = bundleFilePath, ///
             bundle = true,
+            minify = release,
             options = {
               entryPoints,
               outfile,
-              bundle
+              bundle,
+              minify
             };
 
       if (debug) {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "watchful-cli",
   "author": "James Smith",
-  "version": "1.7.35",
+  "version": "1.7.38",
   "license": "MIT, Anti-996",
   "homepage": "https://github.com/djalbat/watchful-cli",
   "description": "Incremental transpilation with bundling.",