@adamlui/minify.js 1.4.2 → 1.4.3

package/README.md

@@ -20,7 +20,7 @@
 
 <a href="https://www.npmjs.com/package/@adamlui/minify.js"><img height=31 src="https://img.shields.io/npm/dt/%40adamlui%2Fminify.js?logo=npm&logoColor=white&labelColor=464646&style=for-the-badge"></a>
 <a href="#%EF%B8%8F-mit-license"><img height=31 src="https://img.shields.io/badge/License-MIT-red.svg?logo=internetarchive&logoColor=white&labelColor=464646&style=for-the-badge"></a>
-<a href="https://www.npmjs.com/package/@adamlui/minify.js?activeTab=versions"><img height=31 src="https://img.shields.io/badge/Latest_Build-1.4.2-fc7811.svg?logo=icinga&logoColor=white&labelColor=464646&style=for-the-badge"></a>
+<a href="https://www.npmjs.com/package/@adamlui/minify.js?activeTab=versions"><img height=31 src="https://img.shields.io/badge/Latest_Build-1.4.3-fc7811.svg?logo=icinga&logoColor=white&labelColor=464646&style=for-the-badge"></a>
 <a href="https://www.npmjs.com/package/@adamlui/minify.js?activeTab=code"><img height=31 src="https://img.shields.io/npm/unpacked-size/%40adamlui%2Fminify.js?style=for-the-badge&logo=ebox&logoColor=white&labelColor=464646&color=blue"></a>
 <a href="https://sonarcloud.io/component_measures?metric=new_vulnerabilities&id=adamlui_js-utils:minify.js/minify.js"><img height=31 src="https://img.shields.io/badge/dynamic/json?url=https%3A%2F%2Fsonarcloud.io%2Fapi%2Fmeasures%2Fcomponent%3Fcomponent%3Dadamlui_js-utils%3Aminify.js%2Fminify.js%26metricKeys%3Dvulnerabilities&query=%24.component.measures.0.value&style=for-the-badge&logo=sonarcloud&logoColor=white&labelColor=464646&label=Vulnerabilities&color=gold"></a>
 
@@ -114,20 +114,25 @@ minify-js input_folder output_folder
 
 ### Command line options
 
-```
-Config options:
- -n, --dry-run               Don't actually minify the file(s), just show
-                             if they will be processed.
- -d, --include-dotfolders    Include dotfolders in file search.
- -D, --include-dotfiles      Include dotfiles in file search.
- -R, --no-recursion          Disable recursive file searching.
- -M, --no-mangle             Disable mangling names.
- -q, --quiet                 Suppress all logging except errors.
+#### Config options:
 
-Info commands:
- -h, --help                  Display help screen.
- -v, --version               Show version number.
-```
+Flag                           | Description
+-------------------------------|-------------------------------------------------------------------------
+`-n` or `--dry-run`            | Don't actually minify the file(s), just show if they will be processed.
+`-d` or `--include-dotfolders` | Include dotfolders in file search.
+`-D` or `--include-dotfiles`   | Include dotfiles in file search.
+`-R` or `--no-recursion`       | Disable recursive file searching.
+`-M` or `--no-mangle`          | Disable mangling names.
+`-q` or `--quiet`              | Suppress all logging except errors.
+
+#### Info commands:
+
+Command             | Description
+--------------------|----------------------
+`-h` or `--help`    | Display help screen.
+`-v` or `--version` | Show version number.
+
+<br>
 
 ## 🔌 API reference
 
@@ -178,14 +183,15 @@ minifyJS.minify(input, { dotFiles: true });
 
 Possible parameters (and their default settings) are:
 
-```
- recursive (true)     Recursively search for nested files if dir path
-                      passed.
- verbose (true)       Show logging in console/terminal.
- dotFolders (false)   Include dotfolders in file search.
- dotFiles (false)     Include dotfiles in file search.
- mangle (true)        Shorten variable names (typically to one character).
-```
+Name         | Desciption                                              | Default value
+-------------|---------------------------------------------------------|---------------
+`recursive`  | Recursively search for nested files if dir path passed. | `true`
+`verbose`    | Show logging in console/terminal.                       | `true`
+`dotFolders` | Include dotfolders in file search.                      | `false`
+`dotFiles`   | Include dotfiles in file search.                        | `false`
+`mangle`     | Shorten variable names (typically to one character).    | `true`
+
+<br>
 
 ### findJS(searchDir, options)
 
@@ -200,13 +206,12 @@ minifyJS.findJS(searchDir, { recursive: false });
 
 Possible parameters (and their default settings) are:
 
-```
- recursive (true)     Recursively search for nested files if dir path
-                      passed.
- verbose (false)      Show logging in console/terminal.
- dotFolders (false)   Include dotfolders in file search.
- dotFiles (false)     Include dotfiles in file search.
-```
+Name         | Desciption                                              | Default value
+-------------|---------------------------------------------------------|---------------
+`recursive`  | Recursively search for nested files if dir path passed. | `true`
+`verbose`    | Show logging in console/terminal.                       | `true`
+`dotFolders` | Include dotfolders in file search.                      | `false`
+`dotFiles`   | Include dotfiles in file search.                        | `false`
 
 <br>
 

package/minify.js

@@ -8,31 +8,47 @@ const fs = require('fs'),
 // Define MAIN functions
 
 function findJS(searchDir, options = {}) {
-    const defaultOptions = { recursive: true, verbose: false, dotFolders: false, dotFiles: false };
+
+    // Init options
+    const defaultOptions = { recursive: true, verbose: true, dotFolders: false, dotFiles: false };
     options = { ...defaultOptions, ...options };
+
+    // Search for unminified JS
     const dirFiles = fs.readdirSync(searchDir), jsFiles = [];
+    if (options.verbose && !options.isRecursing) console.info('\nSearching for unminified JS files...');
     dirFiles.forEach(file => {
         const filePath = path.resolve(searchDir, file);
         if (fs.statSync(filePath).isDirectory() && file != 'node_modules'
-            && (options.dotFolders || !file.startsWith('.')) && options.recursive) {
-                if (options.verbose) console.info(`Searching for unminified JS files in: ${filePath}...`);
+            && (options.dotFolders || !file.startsWith('.')) && options.recursive)
                 jsFiles.push( // recursively find unminified JS in eligible dir
                     ...findJS(filePath, { ...options, isRecursing: true }));
-        } else if (/\.js(?<!\.min\.js)$/.test(file)
+        else if (/\.js(?<!\.min\.js)$/.test(file)
             && (options.dotFiles || !file.startsWith('.')))
                 jsFiles.push(filePath); // store eligible unminified JS file for minification
     });
-    if (options.isRecursing || jsFiles.length > 0) return jsFiles;
-    else if (options.verbose) console.info('\nNo unminified JavaScript files found.');
+
+    // Log/return final result
+    if (!options.isRecursing && options.verbose) {
+        console.info('Search complete. '
+            + ( jsFiles.length === 0 ? 'No' : jsFiles.length )
+            + ` file${ jsFiles.length > 1 ? 's' : '' } found.`);
+    }
+    return options.isRecursing || jsFiles.length > 0 ? jsFiles : [];
 }
 
 function minify(input, options = {}) {
+
+    // Init options
     const defaultOptions = {
         recursive: true, verbose: true, dotFolders: false, dotFiles: false, mangle: true };
     options = { ...defaultOptions, ...options };
+
+    // Validate input
     if (typeof input !== 'string')
         return console.error('ERROR:'
             + ' First argument must be a string of source code or file/folder path.');
+
+    // Minify JS based on input
     const minifyOptions = { mangle: options.mangle ? { toplevel: true } : false };
     if (fs.existsSync(input)) { // minify based on path arg
         if (input.endsWith('.js')) { // file path passed
@@ -41,10 +57,9 @@ function minify(input, options = {}) {
             if (minifyResult.error) console.error(`ERROR: ${ minifyResult.error.message }`);
             return { code: minifyResult.code, srcPath: input, error: minifyResult.error };
         } else { // dir path passed
-            if (options.verbose) console.info('Searching for unminified JS files...');
-            return findJS(input, { recursive: options.recursive,
-                                   dotFolders: options.dotFolders, dotFiles: options.dotFiles })
-                ?.map(jsPath => { // minify found JS files
+            return findJS(input, { recursive: options.recursive, verbosity: options.verbose,
+                                   dotFolders: options.dotFolders, dotFiles: options.dotFiles 
+                })?.map(jsPath => { // minify found JS files
                     if (options.verbose) console.info(`Minifying ${ jsPath }...`);
                     const srcCode = fs.readFileSync(jsPath, 'utf8'),
                           minifyResult = uglifyJS.minify(srcCode, minifyOptions);
@@ -66,7 +81,7 @@ if (require.main !== module) module.exports = { minify, findJS };
 else { // run as CLI tool
 
     // Init UI colors
-    const nc = '\x1b[0m', // no color
+    const nc = '\x1b[0m',    // no color
           br = '\x1b[1;91m', // bright red
           by = '\x1b[1;33m', // bright yellow
           bg = '\x1b[1;92m'; // bright green
@@ -75,14 +90,14 @@ else { // run as CLI tool
     const config = {
         dryRun: process.argv.some(arg => /^--?(?:n|dry-?run)$/.test(arg)),
         includeDotFolders: process.argv.some(arg =>
-            /^--?(?:dd?|(?:include-?)?dot-?(?:folder|dir(?:ector(?:y|ie))?)s?)$/.test(arg)),
+            /^--?(?:dd?|(?:include-?)?dot-?(?:folder|dir(?:ector(?:y|ie))?)s?=?(?:true|1)?)$/.test(arg)),
         includeDotFiles: process.argv.some(arg =>
-            /^--?(?:df|D|(?:include-?)?dot-?files?)$/.test(arg)),
+            /^--?(?:df|D|(?:include-?)?dot-?files?=?(?:true|1)?)$/.test(arg)),
         noRecursion: process.argv.some(arg =>
-            /^--?(?:R|(?:disable|no)-?recursion)$/.test(arg)),
+            /^--?(?:R|(?:disable|no)-?recursion|recursion=(?:false|0))$/.test(arg)),
         noMangle: process.argv.some(arg =>
-            /^--?(?:M|(?:disable|no)-?mangle)$/.test(arg)),
-        quietMode: process.argv.some(arg => /^--?q(?:uiet)?$/.test(arg))
+            /^--?(?:M|(?:disable|no)-?mangle|mangle=(?:false|0))$/.test(arg)),
+        quietMode: process.argv.some(arg => /^--?q(?:uiet)?(?:-?mode)?$/.test(arg))
     };
 
     // Show HELP screen if -h or --help passed
@@ -131,19 +146,20 @@ else { // run as CLI tool
         }
 
         // Find all eligible JavaScript files or arg-passed file
-        printIfNotQuiet('Searching for unminified JS files...');
         const unminnedJSfiles = inputArg.endsWith('.js') ? [inputPath]
-            : findJS(inputPath, { recursive: !config.noRecursion });
+            : findJS(inputPath, { recursive: !config.noRecursion, verbose: !config.quietMode });
 
-        if (config.dryRun && unminnedJSfiles?.length > 0) { // print files to be processed
-            console.info(`\n${by}JS files to be minified:${nc}`);
-            unminnedJSfiles?.forEach(file => console.info(file));
+        if (config.dryRun) { // -n or --dry-run passed
+            if (unminnedJSfiles.length > 0) { // print files to be processed
+                console.info(`\n${by}JS files to be minified:${nc}`);
+                unminnedJSfiles.forEach(file => console.info(file));
+            } else console.info(`${by}\nNo JS files will be minified.${nc}`);
 
         } else { // actually minify JavaScript files
 
             // Build array of minification data
             const failedPaths = [];
-            const minifyData = unminnedJSfiles?.map(jsPath => {
+            const minifyData = unminnedJSfiles.map(jsPath => {
                 const minifyResult = minify(jsPath, { verbose: !config.quietMode, mangle: !config.noMangle });
                 if (minifyResult.error) failedPaths.push(jsPath);
                 return minifyResult;
@@ -172,7 +188,7 @@ else { // run as CLI tool
                 printIfNotQuiet(`\n${bg}Minification complete!${nc}`);
                 printIfNotQuiet(
                     `${ minifyData.length } file${ minifyData.length > 1 ? 's' : '' } minified.`);
-            } else printIfNotQuiet(`${by}No unminified JavaScript files processed successfully.${nc}`);
+            } else printIfNotQuiet(`${by}No unminified JavaScript files processed.${nc}`);
             if (failedPaths.length > 0) {
                 printIfNotQuiet(`\n${br}`
                     + `${ failedPaths.length } file${ failedPaths.length > 1 ? 's' : '' }`

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adamlui/minify.js",
-  "version": "1.4.2",
+  "version": "1.4.3",
   "description": "Recursively minify all JavaScript files",
   "author": {
     "name": "Adam Lui",