@adamlui/minify.js 1.4.3 → 1.4.5

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.3-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.5-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,57 +88,59 @@ 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
-
-#### Config options:
+#
 
-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.
+### Command line options
 
-#### Info commands:
+```
+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.
 
-Command             | Description
---------------------|----------------------
-`-h` or `--help`    | Display help screen.
-`-v` or `--version` | Show version number.
+Info commands:
+ -h, --help                  Display help screen.
+ -v, --version               Show version number.
+```
 
 <br>
 
-## 🔌 API reference
+<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.
 
@@ -150,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.
@@ -168,20 +177,22 @@ 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:
+Available parameters (and their default settings) are:
 
 Name         | Desciption                                              | Default value
 -------------|---------------------------------------------------------|---------------
@@ -191,20 +202,28 @@ Name         | Desciption                                              | Default
 `dotFiles`   | Include dotfiles in file search.                        | `false`
 `mangle`     | Shorten variable names (typically to one character).    | `true`
 
-<br>
+#
 
-### 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
-minifyJS.findJS(searchDir, { recursive: false });
-// returns array containing filepaths to unminified JS files in exactly `searchDir`
+// Search for unminified JS files in exactly `assets/js`:
+const searchResults = minifyJS.findJS('assets/js', { recursive: false });
+console.log(searchResults);
+
+/* outputs:
+Searching for unminified JS files...
+Search complete. 2 files found.
+[ 'E:\\js\\utils\\minify.js\\assets\\js\\foo.js',
+  'E:\\js\\utils\\minify.js\\assets\\js\\bar.js' ]
+*/
 ```
 
-Possible parameters (and their default settings) are:
+Available parameters (and their default settings) are:
 
 Name         | Desciption                                              | Default value
 -------------|---------------------------------------------------------|---------------
@@ -215,10 +234,7 @@ Name         | Desciption                                              | Default
 
 <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

@@ -13,6 +13,28 @@ function findJS(searchDir, options = {}) {
     const defaultOptions = { recursive: true, verbose: true, dotFolders: false, dotFiles: false };
     options = { ...defaultOptions, ...options };
 
+    // Validate searchDir
+    if (!searchDir) return console.error(
+        'findJS() error: Please supply a `searchDir` arg.');
+    else if (typeof searchDir !== 'string') return console.error(
+        'findJS() error: Arg `searchDir` must be a string.');
+    else { // verify searchDir path existence
+        const searchPath = path.resolve(process.cwd(), searchDir);
+        if (!fs.existsSync(searchPath)) return console.error(
+            'findJS() error: Arg `searchDir` must be an existing directory.'
+                + `\n'${ searchPath }' does not exist.`);
+    }
+
+    // Validate options
+    for (const key of Object.keys(options)) {
+        if (!Object.prototype.hasOwnProperty.call(defaultOptions, key))
+            if (key !== 'isRecursing') return console.error(
+                `findJS() error: \`${ key }\` is an invalid option.`
+                    + `\nValid options: [ ${Object.keys(defaultOptions).join(', ')} ]`);
+        else if (typeof options[key] !== 'boolean') return console.error(
+            `findJS() error: \`${ key }\` option must be set to \`true\` or \`false\`.`);
+    }
+
     // Search for unminified JS
     const dirFiles = fs.readdirSync(searchDir), jsFiles = [];
     if (options.verbose && !options.isRecursing) console.info('\nSearching for unminified JS files...');
@@ -44,9 +66,17 @@ function minify(input, options = {}) {
     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.');
+    if (typeof input !== 'string') return console.error(
+        'minify() error: Arg `inputPath` must be a string.');
+
+    // Validate options
+    for (const key of Object.keys(options)) {
+        if (!Object.prototype.hasOwnProperty.call(defaultOptions, key)) return console.error(
+            `findJS() error: \`${ key }\` is an invalid option.`
+                + `\nValid options: [ ${Object.keys(defaultOptions).join(', ')} ]`);
+        else if (typeof options[key] !== 'boolean') return console.error(
+            `findJS() error: \`${ key }\` option must be set to \`true\` or \`false\`.`);
+    }
 
     // Minify JS based on input
     const minifyOptions = { mangle: options.mangle ? { toplevel: true } : false };
@@ -55,9 +85,10 @@ function minify(input, options = {}) {
             if (options.verbose) console.info(`Minifying ${ input }...`);
             const minifyResult = uglifyJS.minify(fs.readFileSync(input, 'utf8'), minifyOptions);
             if (minifyResult.error) console.error(`ERROR: ${ minifyResult.error.message }`);
-            return { code: minifyResult.code, srcPath: input, error: minifyResult.error };
+            return { code: minifyResult.code, srcPath: path.resolve(process.cwd(), input),
+                     error: minifyResult.error };
         } else { // dir path passed
-            return findJS(input, { recursive: options.recursive, verbosity: options.verbose,
+            return findJS(input, { recursive: options.recursive, verbose: options.verbose,
                                    dotFolders: options.dotFolders, dotFiles: options.dotFiles 
                 })?.map(jsPath => { // minify found JS files
                     if (options.verbose) console.info(`Minifying ${ jsPath }...`);
@@ -71,14 +102,14 @@ function minify(input, options = {}) {
         if (options.verbose) console.info('Minifying passed source code...');
         const minifyResult = uglifyJS.minify(input, minifyOptions);
         if (minifyResult.error) console.error(`ERROR: ${ minifyResult.error.message }`);
-        return { code: minifyResult.code, srcPath: input, error: minifyResult.error };
+        return { code: minifyResult.code, srcPath: undefined, error: minifyResult.error };
     }
 }
 
-// EXPORT functions if script was required
+// EXPORT main functions if script was required
 if (require.main !== module) module.exports = { minify, findJS };
 
-else { // run as CLI tool
+else { // run as CLI utility
 
     // Init UI colors
     const nc = '\x1b[0m',    // no color
@@ -87,46 +118,36 @@ else { // run as CLI tool
           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?=?(?:true|1)?)$/.test(arg)),
-        includeDotFiles: process.argv.some(arg =>
-            /^--?(?:df|D|(?:include-?)?dot-?files?=?(?:true|1)?)$/.test(arg)),
-        noRecursion: process.argv.some(arg =>
-            /^--?(?:R|(?:disable|no)-?recursion|recursion=(?:false|0))$/.test(arg)),
-        noMangle: process.argv.some(arg =>
-            /^--?(?:M|(?:disable|no)-?mangle|mangle=(?:false|0))$/.test(arg)),
-        quietMode: process.argv.some(arg => /^--?q(?:uiet)?(?:-?mode)?$/.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}`);
+            printHelpSections(['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))) printHelpSections();
 
     // 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
@@ -139,7 +160,7 @@ else { // run as CLI tool
         const inputPath = path.resolve(process.cwd(), inputArg);
         if (inputArg && !fs.existsSync(inputPath)) {
             console.error(`\n${br}Error: First argument must be an existing file or directory.`
-                + `'\n${ inputPath }' does not exist.${nc}`
+                + `\n'${ inputPath }' does not exist.${nc}`
                 + `\n\n${bg}Example valid command: \n>> minify-js . output.min.js${nc}`
                 + `\n\n${by}For all command options: \n>> minify-js --help${nc}`);
             process.exit(1);
@@ -200,27 +221,61 @@ else { // run as CLI tool
 
     // Define LOGGING functions
 
-    function printHelp(msg) { // wrap msg + indent 2nd+ lines (for --help screen)
-        const terminalWidth = process.stdout.columns || 80,
-              indentation = 29, lines = [], words = msg.match(/\S+|\s+/g);
-
-        // Split msg into lines of appropriate lengths
-        let currentLine = '';
-        words.forEach(word => {
-            const lineLength = terminalWidth - ( lines.length === 0 ? 0 : indentation );
-            if (currentLine.length + word.length > lineLength) { // cap/store it
-                lines.push(lines.length === 0 ? currentLine : currentLine.trimStart());
-                currentLine = '';
-            }
-            currentLine += word;
-        });
-        lines.push(lines.length === 0 ? currentLine : currentLine.trimStart());
-
-        // Print formatted msg
-        lines.forEach((line, index) => console.info(
-            index === 0 ? line // print 1st line unindented
-                : ' '.repeat(indentation) + line // print subsequent lines indented
-        ));
+    function printHelpSections(includeSections = ['cmdFormat', 'pathArgs', 'configOptions', 'infoCmds']) {
+        const helpSections = {
+            'cmdFormat': [
+                `\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
+            helpSections[section]?.forEach(line => printHelpMsg(line)); });
+
+        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);
+
+            // Split msg into lines of appropriate lengths
+            let currentLine = '';
+            words.forEach(word => {
+                const lineLength = terminalWidth - ( lines.length === 0 ? 0 : indentation );
+                if (currentLine.length + word.length > lineLength) { // cap/store it
+                    lines.push(lines.length === 0 ? currentLine : currentLine.trimStart());
+                    currentLine = '';
+                }
+                currentLine += word;
+            });
+            lines.push(lines.length === 0 ? currentLine : currentLine.trimStart());
+
+            // Print formatted msg
+            lines.forEach((line, index) => console.info(
+                index === 0 ? line // print 1st line unindented
+                    : ' '.repeat(indentation) + line // print subsequent lines indented
+            ));
+        }
     }
 
     function printIfNotQuiet(msg) { if (!config.quietMode) console.info(msg); }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adamlui/minify.js",
-  "version": "1.4.3",
+  "version": "1.4.5",
   "description": "Recursively minify all JavaScript files",
   "author": {
     "name": "Adam Lui",
@@ -15,10 +15,11 @@
     "minify-js": "minify.js"
   },
   "scripts": {
-    "test": "bash utils/test/minify.test.sh",
+    "test": "bash utils/test/minify-cli.test.sh",
     "bump:patch": "bash utils/bump.sh patch",
     "bump:minor": "bash utils/bump.sh minor",
     "bump:major": "bash utils/bump.sh major",
+    "prepublish": "npm test",
     "publish:patch": "bash utils/bump.sh patch --publish",
     "publish:minor": "bash utils/bump.sh minor --publish",
     "publish:major": "bash utils/bump.sh major --publish"