@adamlui/minify.js 1.4.6 → 1.4.8

package/README.md

@@ -21,7 +21,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&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://github.com/adamlui/js-utils/releases/tag/minify.js-1.4.6"><img height=31 src="https://img.shields.io/badge/Latest_Build-1.4.6-44cc11.svg?logo=icinga&logoColor=white&labelColor=464646&style=for-the-badge"></a>
+<a href="https://github.com/adamlui/js-utils/releases/tag/minify.js-1.4.8"><img height=31 src="https://img.shields.io/badge/Latest_Build-1.4.8-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>
 
@@ -170,7 +170,7 @@ const srcCode = 'function add(first, second) { return first + second; }',
       minifyResult = minifyJS.minify(srcCode);
 
 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}
+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.
@@ -218,8 +218,9 @@ console.log(searchResults);
 
 /* sample output:
 
-Searching for unminified JS files...
-Search complete. 2 files found.
+findJS() » Searching for unminified JS files...
+findJS() » Search complete! 2 files found.
+findJS() » Check returned array.
 [
   'E:\\js\\utils\\minify.js\\assets\\js\\foo.js',
   'E:\\js\\utils\\minify.js\\assets\\js\\bar.js'
@@ -229,12 +230,12 @@ Search complete. 2 files found.
 
 Available parameters (and their default settings) are:
 
-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`
+Name         | Desciption                                                | Default value
+-------------|-----------------------------------------------------------|---------------
+`recursive`  | Recursively search for nested files in searchDir 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

@@ -10,29 +10,32 @@ const fs = require('fs'),
 function findJS(searchDir, options = {}) {
 
     // Init options
-    const defaultOptions = { recursive: true, verbose: true, dotFolders: false, dotFiles: false };
+    const defaultOptions = {
+        recursive: true,   // recursively search for nested files in searchDir passed
+        verbose: true,     // enable logging
+        dotFolders: false, // include dotfolders in file search
+        dotFiles: false    // include dotfiles in file search
+    };
     options = { ...defaultOptions, ...options };
 
     // Validate searchDir
-    if (!searchDir) return console.error(
-        'findJS() » ERROR: Please supply a `searchDir` as 1st arg.');
-    else if (typeof searchDir !== 'string') return console.error(
-        'findJS() » ERROR: 1st arg `searchDir` must be a string.');
+    if (typeof searchDir !== 'string') return console.error(
+            'findJS() » ERROR: 1st 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.`);
+            'findJS() » ERROR: 1st arg <searchDir> must be an existing directory.\n'
+          + `findJS() » ${ searchPath } does not exist.`);
     }
 
     // Validate options
-    for (const key of Object.keys(options)) {
+    for (const key in options) {
         if (!Object.prototype.hasOwnProperty.call(defaultOptions, key))
             if (key !== 'isRecursing') return console.error(
-                `findJS() » ERROR: \`${ key }\` is an invalid option.`
-                    + `\nfindJS() » Valid options: [ ${Object.keys(defaultOptions).join(', ')} ]`);
+                `findJS() » ERROR: \`${ key }\` is an invalid option.\n`
+              + `findJS() » Valid 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\`.`);
+                `findJS() » ERROR: [${ key }] option can only be set to \`true\` or \`false\`.`);
     }
 
     // Search for unminified JS
@@ -47,16 +50,15 @@ function findJS(searchDir, options = {}) {
                     ...findJS(filePath, { ...options, isRecursing: true }));
         else if (/\.js(?<!\.min\.js)$/.test(file)
             && (options.dotFiles || !file.startsWith('.')))
-                jsFiles.push(filePath); // store eligible unminified JS file for minification
+                jsFiles.push(filePath); // store eligible unminified JS file for returning
     });
 
     // Log/return final result
-    if (!options.isRecursing && options.verbose) {
-        console.info('findJS() » Search complete. '
-            + ( jsFiles.length === 0 ? 'No' : jsFiles.length )
+    if (!options.isRecursing && options.verbose) console.info(
+            'findJS() » Search complete! ' + ( jsFiles.length === 0 ? 'No' : jsFiles.length )
                 + ` file${ jsFiles.length > 1 ? 's' : '' } found.`
-            + ( findJS.caller.name !== 'minify' ? '\nfindJS() » Check returned object.' : '' ));
-    }
+        + ( findJS.caller.name !== 'minify' && require.main !== module ?
+          '\nfindJS() » Check returned array.' : '' ));
     return options.isRecursing || jsFiles.length > 0 ? jsFiles : [];
 }
 
@@ -64,20 +66,25 @@ function minify(input, options = {}) {
 
     // Init options
     const defaultOptions = {
-        recursive: true, verbose: true, dotFolders: false, dotFiles: false, mangle: true };
+        recursive: true,   // recursively search for nested files if dir path passed
+        verbose: true,     // enable logging
+        dotFolders: false, // include dotfolders in file search
+        dotFiles: false,   // include dotfiles in file search
+        mangle: true       // shorten var names (typically to one character)
+    };
     options = { ...defaultOptions, ...options };
 
     // Validate input
     if (typeof input !== 'string') return console.error(
-        'minify() » ERROR: Arg `input` must be a string.');
+        'minify() » ERROR: 1st arg <input> must be a string.');
 
     // Validate options
-    for (const key of Object.keys(options)) {
+    for (const key in options) {
         if (!Object.prototype.hasOwnProperty.call(defaultOptions, key)) return console.error(
-            `minify() » ERROR: \`${ key }\` is an invalid option.`
-                + `\nminify() » Valid options: [ ${Object.keys(defaultOptions).join(', ')} ]`);
+            `minify() » ERROR: \`${ key }\` is an invalid option.\n`
+          + `minify() » Valid options: [ ${ Object.keys(defaultOptions).join(', ') } ]`);
         else if (typeof options[key] !== 'boolean') return console.error(
-            `minify() » ERROR: \`${ key }\` option must be set to \`true\` or \`false\`.`);
+            `minify() » ERROR: [${ key }] option can only be set to \`true\` or \`false\`.`);
     }
 
     // Minify JS based on input
@@ -87,7 +94,6 @@ function minify(input, options = {}) {
             if (options.verbose) console.info(`minify() » Minifying ${ input }...`);
             const minifyResult = uglifyJS.minify(fs.readFileSync(input, 'utf8'), minifyOptions);
             if (minifyResult.error) console.error(`minify() » ERROR: ${ minifyResult.error.message }`);
-            else console.info('minify() » Minification complete! Check returned object.');
             return { code: minifyResult.code, srcPath: path.resolve(process.cwd(), input),
                      error: minifyResult.error };
         } else { // dir path passed
@@ -98,7 +104,6 @@ function minify(input, options = {}) {
                     const srcCode = fs.readFileSync(jsPath, 'utf8'),
                           minifyResult = uglifyJS.minify(srcCode, minifyOptions);
                     if (minifyResult.error) console.error(`minify() » ERROR: ${ minifyResult.error.message }`);
-                    else console.info('minify() » Minification complete! Check returned object.');
                     return { code: minifyResult.code, srcPath: jsPath, error: minifyResult.error };
                 }).filter(data => !data.error); // filter out failed minifications
         }
@@ -106,7 +111,7 @@ function minify(input, options = {}) {
         if (options.verbose) console.info('minify() » Minifying passed source code...');
         const minifyResult = uglifyJS.minify(input, minifyOptions);
         if (minifyResult.error) console.error(`minify() » ERROR: ${ minifyResult.error.message }`);
-        else console.info('minify() » Minification complete! Check returned object.');
+
         return { code: minifyResult.code, srcPath: undefined, error: minifyResult.error };
     }
 }
@@ -164,8 +169,8 @@ else { // run as CLI utility
         // Validate input arg (output arg can be anything)
         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}`
+            console.error(`\n${br}Error: First argument can only be an existing file or directory.`
+                + `\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);
@@ -195,9 +200,10 @@ else { // run as CLI utility
             minifyData?.forEach(({ code, srcPath }) => {
                 const outputDir = path.join(
                     path.dirname(srcPath), // path of file to be minified
-                    /so?u?rce?$/.test(path.dirname(srcPath)) ? '../min' // + ../min/ if in *(src|source)/
-                        : outputArg.endsWith('.js') ? path.dirname(outputArg) // or path from file output arg
-                        : outputArg || 'min' // or path from folder output arg or min/ if no output arg passed
+                    /so?u?rce?$/.test(path.dirname(srcPath)) ? (
+                        '../' + ( outputArg || 'min' ) // + ../outputArg|min/ if in *(src|source)/
+                    ) : outputArg.endsWith('.js') ? path.dirname(outputArg) // or path from file output arg
+                      : outputArg || 'min' // or path from folder outputArg or min/ if no outputArg passed
                 );
                 const outputFilename = (
                     outputArg.endsWith('.js') && inputArg.endsWith('.js')

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adamlui/minify.js",
-  "version": "1.4.6",
+  "version": "1.4.8",
   "description": "Recursively minify all JavaScript files",
   "author": {
     "name": "Adam Lui",
@@ -14,12 +14,17 @@
     "minifyjs": "minify.js",
     "minify-js": "minify.js"
   },
+  "directories": {
+    "lib": ".",
+    "doc": "./docs",
+    "test": "./utils/test"
+  },
   "scripts": {
     "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",
+    "prepublishOnly": "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"