@adamlui/minify.js 1.4.2 → 1.4.4

package/README.md

@@ -18,9 +18,9 @@
 
 ### Recursively minify all JavaScript files.
 
-<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"><img height=31 src="https://img.shields.io/npm/dt/%40adamlui%2Fminify.js?logo=npm&color=af68ff&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-orange.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.4-44cc11.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>
 
@@ -28,34 +28,38 @@
 
 <br>
 
-<img height=8px width="100%" src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/aqua-separator.png">
+<img height=6px width="100%" src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/aqua-separator.png">
 
 ## ⚡ Installation
 
 As a **global utility**:
 
 ```
-npm install -g @adamlui/minify.js
+$ npm install -g @adamlui/minify.js
 ```
 
 As a **dev dependency** (e.g. for build scripts), from your project root:
 
 ```
-npm install -D @adamlui/minify.js
+$ npm install -D @adamlui/minify.js
 ```
 
 As a **runtime dependency** (e.g. for on-the-fly minification), from your project root:
 
 ```
-npm install @adamlui/minify.js
+$ npm install @adamlui/minify.js
 ```
 
+<br>
+
+<img height=6px width="100%" src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/aqua-separator.png">
+
 ## 💻 Command line usage
 
 The basic **global command** is:
 
 ```
-minify-js
+$ minify-js
 ```
 
 **💡 Note:** Pass `-n` or `--dry-run` to only see what files will be processed.
@@ -65,7 +69,7 @@ minify-js
 To specify **input/output** paths:
    
 ```
-minify-js [input_path] [output_path]
+$ minify-js [input_path] [output_path]
 ```
 
 - `[input_path]`: Path to JS file or directory containing JS files to be minified, relative to the current working directory.
@@ -84,34 +88,37 @@ To use as a **package script**, in your project's `package.json`:
 ```
 
 Replace `<minify-js-cmd>` with `minify-js` + optional args. Then, `npm run build:js` can be used to run the command.
-<br><br>
+
+#
 
 ### Example commands
 
 Minify all JavaScript files in the **current directory** (outputs to `min/`):
 
 ```
-minify-js
+$ minify-js
 ```
 
 Minify all JavaScript files in a **specific directory** (outputs to `path/to/your/directory/min/`):
 
 ```
-minify-js path/to/your/directory
+$ minify-js path/to/your/directory
 ```
 
 Minify a **specific file** (outputs to `path/to/your/min/file.min.js`):
 
 ```
-minify-js path/to/your/file.js
+$ minify-js path/to/your/file.js
 ```
 
 Specify both **input and output** directories (outputs to `output_folder/`):
 
 ```
-minify-js input_folder output_folder
+$ minify-js input_folder output_folder
 ```
 
+#
+
 ### Command line options
 
 ```
@@ -129,7 +136,11 @@ Info commands:
  -v, --version               Show version number.
 ```
 
-## 🔌 API reference
+<br>
+
+<img height=6px width="100%" src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/aqua-separator.png">
+
+## 🔌 API usage
 
 You can also import **minify.js** into your app to use its API methods, both as an ECMAScript module or a CommonJS module.
 
@@ -145,17 +156,20 @@ import * as minifyJS from '@adamlui/minify.js';
 const minifyJS = require('@adamlui/minify.js');
 ```
 
-### minify(input, options)
+#
+
+### `minify(input[, options])`
 
-This function minifies JavaScript code based on the string input supplied.
+Minifies JavaScript code based on the string input supplied.
 
 If **source code** is passed, it is directly minified, then an object containing `srcPath` + `code` + `error` is returned:
 
 ```js
 const srcCode = 'function add(first, second) { return first + second; }',
       minifyResult = minifyJS.minify(srcCode);
-console.log(minifyResult.error); // runtime error, or `undefined` if no error
-console.log(minifyResult.code);  // minified output: function add(n,d){return n+d}
+
+console.log(minifyResult.error); // outputs runtime error, or `undefined` if no error
+console.log(minifyResult.code);  // outputs minified JS: function add(n,d){return n+d}
 ```
 
 If a **file path** is passed, the file's code is loaded then minified, returning an object like above.
@@ -163,57 +177,56 @@ If a **file path** is passed, the file's code is loaded then minified, returning
 If a **directory path** is passed, JavaScript files are searched for (recursively by default), each one's code is loaded then minified, then an array of objects containing `srcPath` + `code` + `error` is returned:
 
 ```js
-const results = minifyJS.minify('.');
-results.forEach(result =>
-    console.log(result.srcPath)); // paths to JS files in working directory + all nested directories
-console.log(results[1].code);     // minified code of 2nd JS file if found, or `undefined` if not found
+// Outputs paths to source JS files in working directory + all nested directories
+const minifyResults = minifyJS.minify('.');
+minifyResults.forEach(result => console.log(result.srcPath));
+
+// Outputs minified code of 2nd JS file if found, or `undefined` if not found
+console.log(minifyResults[1].code);
 ```
 
 Options are boolean, passed as object properties. For example:
 
 ```js
+// Returns data object where dotfiles are also processed if `input` is a path
 minifyJS.minify(input, { dotFiles: true });
-// returns data object where dotfiles are also processed if `input` is a path
 ```
 
 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`
 
-### findJS(searchDir, options)
+#
+
+### `findJS(searchDir[, options])`
 
-This function searches for all unminified JavaScript files within the `searchDir` string passed (useful for discovering what files [`minify()`](#minifyinput-options) will process) and returns an array containing their filepaths.
+Searches for all unminified JavaScript files within the `searchDir` string passed (useful for discovering what files [`minify()`](#minifyinput-options) will process) and returns an array containing their filepaths.
 
 Options are boolean, passed as object properties. For example:
 
 ```js
+// Returns array containing filepaths to unminified JS files in exactly `searchDir`
 minifyJS.findJS(searchDir, { recursive: false });
-// returns array containing filepaths to unminified JS files in exactly `searchDir`
 ```
 
 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>
 
-## 💖 Support
-
-Please consider [giving a GitHub ⭐](https://github.com/adamlui/js-utils) if this helped you!
-<br><br>
+<img height=6px width="100%" src="https://raw.githubusercontent.com/adamlui/js-utils/main/docs/images/aqua-separator.png">
 
 ## 🏛️ MIT License
 

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,52 +81,42 @@ 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
 
     // Load FLAG settings
-    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)),
-        includeDotFiles: process.argv.some(arg =>
-            /^--?(?:df|D|(?:include-?)?dot-?files?)$/.test(arg)),
-        noRecursion: process.argv.some(arg =>
-            /^--?(?:R|(?:disable|no)-?recursion)$/.test(arg)),
-        noMangle: process.argv.some(arg =>
-            /^--?(?:M|(?:disable|no)-?mangle)$/.test(arg)),
-        quietMode: process.argv.some(arg => /^--?q(?:uiet)?$/.test(arg))
+    const config = {};
+    const argRegex = {
+        'dryRun': /^--?(?:n|dry-?run)$/,
+        'includeDotFolders': /^--?(?:dd?|(?:include-?)?dot-?(?:folder|dir(?:ector(?:y|ie))?)s?=?(?:true|1)?)$/,
+        'includeDotFiles': /^--?(?:df|D|(?:include-?)?dot-?files?=?(?:true|1)?)$/,
+        'noRecursion': /^--?(?:R|(?:disable|no)-?recursion|recursion=(?:false|0))$/,
+        'noMangle': /^--?(?:M|(?:disable|no)-?mangle|mangle=(?:false|0))$/,
+        'quietMode': /^--?q(?:uiet)?(?:-?mode)?$/,
+        'help': /^--?h(?:elp)?$/,
+        'version': /^--?ve?r?s?i?o?n?$/
     };
+    process.argv.forEach(arg => {
+        if (!arg.startsWith('-')) return;
+        const matchedFlag = Object.keys(argRegex).find(flag => argRegex[flag].test(arg));
+        if (matchedFlag) config[matchedFlag] = true;
+        else {
+            console.error(`\n${br}ERROR: Arg '${ arg }' not recognized.${nc}`);
+            console.info(`\n${by}Valid arguments are below.${nc}`);
+            printHelpScreen(['configOptions', 'infoCmds']);
+            process.exit(1);
+    }});
 
     // Show HELP screen if -h or --help passed
-    if (process.argv.some(arg => /^--?h(?:elp)?$/.test(arg))) {
-        printHelp(`\n${by}minify-js [inputPath] [outputPath] [options]${nc}`);
-        printHelp('\nPath arguments:');
-        printHelp(' [inputPath]                 '
-            + 'Path to JS file or directory containing JS files to be minified,'
-            + ' relative to the current working directory.');
-        printHelp(' [outputPath]                '
-            + 'Path to file or directory where minified files will be stored,'
-            + ' relative to original file location (if not provided, min/ is used).');
-        printHelp('\nConfig options:');
-        printHelp(' -n, --dry-run               Don\'t actually minify the file(s),'
-            + ' just show if they will be processed.');
-        printHelp(' -d, --include-dotfolders    Include dotfolders in file search.');
-        printHelp(' -D, --include-dotfiles      Include dotfiles in file search.');
-        printHelp(' -R, --no-recursion          Disable recursive file searching.');
-        printHelp(' -M, --no-mangle             Disable mangling names.');
-        printHelp(' -q, --quiet                 Suppress all logging except errors.');
-        printHelp('\nInfo commands:');
-        printHelp(' -h, --help                  Display this help screen.');
-        printHelp(' -v, --version               Show version number.');
+    if (process.argv.some(arg => argRegex.help.test(arg))) printHelpScreen();
 
     // Show VERSION number if -v or --version passed
-    } else if (process.argv.some(arg => /^--?ve?r?s?i?o?n?$/.test(arg))) {
+    else if (process.argv.some(arg => argRegex.version.test(arg)))
         console.info('v' + require('./package.json').version);
 
-    } else { // run MAIN routine
+    else { // run MAIN routine
 
         // Init I/O args
         const [inputArg = '', outputArg = ''] = ( // default to empty strings for error-less handling
@@ -131,19 +136,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 +178,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' : '' }`
@@ -184,7 +190,7 @@ else { // run as CLI tool
 
     // Define LOGGING functions
 
-    function printHelp(msg) { // wrap msg + indent 2nd+ lines (for --help screen)
+    function printHelpMsg(msg) { // wrap msg + indent 2nd+ lines (for --help screen)
         const terminalWidth = process.stdout.columns || 80,
               indentation = 29, lines = [], words = msg.match(/\S+|\s+/g);
 
@@ -207,5 +213,39 @@ else { // run as CLI tool
         ));
     }
 
+    function printHelpScreen(includeSections = ['sampleCmd', 'pathArgs', 'configOptions', 'infoCmds']) {
+        const sections = {
+            'sampleCmd': [
+                `\n${by}minify-js [inputPath] [outputPath] [options]${nc}`
+            ],
+            'pathArgs': [
+                '\nPath arguments:',
+                ' [inputPath]                 '
+                    + 'Path to JS file or directory containing JS files to be minified,'
+                    + ' relative to the current working directory.',
+                ' [outputPath]                '
+                    + 'Path to file or directory where minified files will be stored,'
+                    + ' relative to original file location (if not provided, min/ is used).'
+            ],
+            'configOptions': [
+                '\nConfig 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.'
+            ],
+            'infoCmds': [
+                '\nInfo commands:',
+                ' -h, --help                  Display help screen.',
+                ' -v, --version               Show version number.'
+            ]
+        };
+        includeSections.forEach(section => { // print valid arg elems
+            if (sections[section]) sections[section].forEach(line => printHelpMsg(line)); });
+    }
+
     function printIfNotQuiet(msg) { if (!config.quietMode) console.info(msg); }
 }

package/package.json

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