@adamlui/minify.js 1.4.4 → 1.4.6

package/README.md

@@ -10,7 +10,8 @@
         <a href="https://github.com/adamlui/js-utils/tree/main/minify.js/docs/hi#readme">हिंदी</a> |
         <a href="https://github.com/adamlui/js-utils/tree/main/minify.js/docs/bn#readme">বাংলা</a> |
         <a href="https://github.com/adamlui/js-utils/tree/main/minify.js/docs/mr#readme">मराठी</a> |
-        <a href="https://github.com/adamlui/js-utils/tree/main/minify.js/docs/pa#readme">ਪੰਜਾਬੀ</a>
+        <a href="https://github.com/adamlui/js-utils/tree/main/minify.js/docs/pa#readme">ਪੰਜਾਬੀ</a> |
+        <a href="https://github.com/adamlui/js-utils/tree/main/minify.js/docs/de#readme">Deutsch</a>
     </h6>
 </div>
 
@@ -20,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://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://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://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>
 
@@ -192,7 +193,7 @@ Options are boolean, passed as object properties. For example:
 minifyJS.minify(input, { dotFiles: true });
 ```
 
-Possible parameters (and their default settings) are:
+Available parameters (and their default settings) are:
 
 Name         | Desciption                                              | Default value
 -------------|---------------------------------------------------------|---------------
@@ -211,11 +212,22 @@ Searches for all unminified JavaScript files within the `searchDir` string passe
 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 });
+// Search for unminified JS files in exactly assets/js:
+const searchResults = minifyJS.findJS('assets/js', { recursive: false });
+console.log(searchResults);
+
+/* sample output:
+
+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
 -------------|---------------------------------------------------------|---------------

package/docs/LICENSE.md

@@ -10,7 +10,8 @@
         <a href="hi/LICENSE.md">हिंदी</a> |
         <a href="bn/LICENSE.md">বাংলা</a> |
         <a href="mr/LICENSE.md">मराठी</a> |
-        <a href="pa/LICENSE.md">ਪੰਜਾਬੀ</a>
+        <a href="pa/LICENSE.md">ਪੰਜਾਬੀ</a> |
+        <a href="de/LICENSE.md">Deutsch</a>  
     </h6>
 </div>
 

package/docs/SECURITY.md

@@ -10,7 +10,8 @@
         <a href="hi/SECURITY.md">हिंदी</a> |
         <a href="bn/SECURITY.md">বাংলা</a> |
         <a href="mr/SECURITY.md">मराठी</a> |
-        <a href="pa/SECURITY.md">ਪੰਜਾਬੀ</a>
+        <a href="pa/SECURITY.md">ਪੰਜਾਬੀ</a> |
+        <a href="de/SECURITY.md">Deutsch</a>
     </h6>
 </div>
 

package/minify.js

@@ -13,9 +13,32 @@ 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` as 1st arg.');
+    else 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.`);
+    }
+
+    // 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.`
+                    + `\nfindJS() » 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\`.`);
+    }
+
     // Search for unminified JS
     const dirFiles = fs.readdirSync(searchDir), jsFiles = [];
-    if (options.verbose && !options.isRecursing) console.info('\nSearching for unminified JS files...');
+    if (options.verbose && !options.isRecursing) console.info(
+        '\nfindJS() » Searching for unminified JS files...');
     dirFiles.forEach(file => {
         const filePath = path.resolve(searchDir, file);
         if (fs.statSync(filePath).isDirectory() && file != 'node_modules'
@@ -29,9 +52,10 @@ function findJS(searchDir, options = {}) {
 
     // Log/return final result
     if (!options.isRecursing && options.verbose) {
-        console.info('Search complete. '
+        console.info('findJS() » Search complete. '
             + ( jsFiles.length === 0 ? 'No' : jsFiles.length )
-            + ` file${ jsFiles.length > 1 ? 's' : '' } found.`);
+                + ` file${ jsFiles.length > 1 ? 's' : '' } found.`
+            + ( findJS.caller.name !== 'minify' ? '\nfindJS() » Check returned object.' : '' ));
     }
     return options.isRecursing || jsFiles.length > 0 ? jsFiles : [];
 }
@@ -44,41 +68,53 @@ 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 `input` must be a string.');
+
+    // Validate options
+    for (const key of Object.keys(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(', ')} ]`);
+        else if (typeof options[key] !== 'boolean') return console.error(
+            `minify() » ERROR: \`${ key }\` option must be set to \`true\` or \`false\`.`);
+    }
 
     // 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
-            if (options.verbose) console.info(`Minifying ${ input }...`);
+            if (options.verbose) console.info(`minify() » 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 };
+            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
-            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 }...`);
+                    if (options.verbose) console.info(`minify() » Minifying ${ jsPath }...`);
                     const srcCode = fs.readFileSync(jsPath, 'utf8'),
                           minifyResult = uglifyJS.minify(srcCode, minifyOptions);
-                    if (minifyResult.error) console.error(`ERROR: ${ minifyResult.error.message }`);
+                    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
         }
     } else { // minify based on src code arg
-        if (options.verbose) console.info('Minifying passed source code...');
+        if (options.verbose) console.info('minify() » 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 };
+        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 };
     }
 }
 
-// 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
@@ -92,7 +128,7 @@ else { // run as CLI tool
         '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))$/,
+        'noRecursion': /^--?(?:R|(?:disable|no)-?recursi(?:on|ve)|recursi(?:on|ve)=(?:false|0))$/,
         'noMangle': /^--?(?:M|(?:disable|no)-?mangle|mangle=(?:false|0))$/,
         'quietMode': /^--?q(?:uiet)?(?:-?mode)?$/,
         'help': /^--?h(?:elp)?$/,
@@ -103,14 +139,14 @@ else { // run as CLI tool
         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.error(`\n${br}ERROR: Arg [${ arg }] not recognized.${nc}`);
             console.info(`\n${by}Valid arguments are below.${nc}`);
-            printHelpScreen(['configOptions', 'infoCmds']);
+            printHelpSections(['configOptions', 'infoCmds']);
             process.exit(1);
     }});
 
     // Show HELP screen if -h or --help passed
-    if (process.argv.some(arg => argRegex.help.test(arg))) printHelpScreen();
+    if (process.argv.some(arg => argRegex.help.test(arg))) printHelpSections();
 
     // Show VERSION number if -v or --version passed
     else if (process.argv.some(arg => argRegex.version.test(arg)))
@@ -129,7 +165,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);
@@ -190,32 +226,9 @@ else { // run as CLI tool
 
     // Define LOGGING functions
 
-    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 printHelpScreen(includeSections = ['sampleCmd', 'pathArgs', 'configOptions', 'infoCmds']) {
-        const sections = {
-            'sampleCmd': [
+    function printHelpSections(includeSections = ['cmdFormat', 'pathArgs', 'configOptions', 'infoCmds']) {
+        const helpSections = {
+            'cmdFormat': [
                 `\n${by}minify-js [inputPath] [outputPath] [options]${nc}`
             ],
             'pathArgs': [
@@ -244,7 +257,30 @@ else { // run as CLI tool
             ]
         };
         includeSections.forEach(section => { // print valid arg elems
-            if (sections[section]) sections[section].forEach(line => printHelpMsg(line)); });
+            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.4",
+  "version": "1.4.6",
   "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"