@caboodle-tech/node-simple-server 3.0.1 → 4.0.0

package/README.md

@@ -308,7 +308,7 @@ With your new instance of NSS you can call any of the following public methods:
 
 ## Changelog
 
-The [current changelog is here](./changelogs/v3.md). All [other changelogs are here](./changelogs).
+The [current changelog is here](./changelogs/v4.md). All [other changelogs are here](./changelogs).
 
 ## Contributions
 

package/bin/nss.js

@@ -43,7 +43,7 @@ class NodeSimpleServer {
         map: {}
     };
 
-    #VERSION = '3.0.1';
+    #VERSION = '4.0.0';
 
     #watching = [];
 
@@ -1018,23 +1018,46 @@ class NodeSimpleServer {
             // Start watching the path(s).
             const watcher = Chokidar.watch(paths, options);
             this.#watching.push(watcher);
+            // Prepare to modify some of the standard Chokidar listeners.
+            const alterAddUpdates = ['add', 'addDir', 'change'];
+            const alterCatachAlls = ['all', 'raw'];
+            const alterUnlinks = ['unlink', 'unlinkDir'];
             // Hookup requested listeners; they are case sensitive so type them right in your code!
-            const safe = ['all', 'add', 'addDir', 'change', 'unlink', 'unlinkDir', 'ready', 'raw', 'error'];
             Object.keys(options.events).forEach((key) => {
-                if (safe.includes(key)) {
-                    /**
-                     * NON-STANDARD ALTERATION
-                     *
-                     * Chokidar provides paths in the correct OS format but NSS will change
-                     * all backslashes (\) into forward slashes (/).
-                     */
-                    watcher.on(key, (evt, path) => {
+                /**
+                 * NON-STANDARD ALTERATIONS!
+                 *
+                 * Chokidar provides paths in the correct OS format but NSS will change
+                 * all backslashes (\) into forward slashes (/).
+                 */
+                if (alterCatachAlls.includes(key)) {
+                    watcher.on(key, (evt, path, statsOrDetails) => {
+                        // Capture the call and alter the path before passing it on.
+                        const altPath = path.replace(/\\/g, '/');
+                        // Since we're messing with the path already grab the extension for the user.
+                        // eslint-disable-next-line no-param-reassign
+                        statsOrDetails.ext = Path.extname(altPath).replace('.', '');
+                        options.events[key](evt, altPath, statsOrDetails);
+                    });
+                } else if (alterAddUpdates.includes(key)) {
+                    watcher.on(key, (path, statsOrDetails) => {
+                        // Capture the call and alter the path before passing it on.
+                        const altPath = path.replace(/\\/g, '/');
+                        // Since we're messing with the path already grab the extension for the user.
+                        // eslint-disable-next-line no-param-reassign
+                        statsOrDetails.ext = Path.extname(altPath).replace('.', '');
+                        options.events[key](altPath, statsOrDetails);
+                    });
+                } else if (alterUnlinks.includes(key)) {
+                    watcher.on(key, (path) => {
                         // Capture the call and alter the path before passing it on.
                         const altPath = path.replace(/\\/g, '/');
                         // Since we're messing with the path already grab the extension for the user.
                         const ext = Path.extname(altPath);
-                        options.events[key](evt, altPath, ext.replace('.', ''));
+                        options.events[key](altPath, ext.replace('.', ''));
                     });
+                } else {
+                    watcher.on(key, options.events[key]);
                 }
             });
         } catch (error) {

package/changelogs/v4.md

@@ -0,0 +1,10 @@
+### NSS 4.0.0 (7 January 2024)
+
+- !feat: Correct bug caused by NSS non-standard implementation of Chokidar; see below.
+
+BREAKING CHANGES: NSS has always modified the standard callback parameters of Chokidar, version 4 modifies this behavior to use the standard callback parameters with the following changes:
+
+1. Extension without the leading dot is moved into the stats or details object for events: `all`, `add`, `addDir`, `change`, and `raw`. For `unlink` and `unlinkDir` the extension is passed as an additional parameter.
+2. NSS now follows the same parameters/arguments structure with the exception of the previous addition.
+
+This will break all code that relies on NSS's old non-standard implementation of parameters/arguments in callback.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@caboodle-tech/node-simple-server",
-    "version": "3.0.1",
+    "version": "4.0.0",
     "description": "Node Simple Server (NSS): A small but effective node based server for development sites, customizable live reloading, and websocket support built-in.",
     "main": "bin/nss.js",
     "scripts": {