Added doc URL to all invalid arg errors ↞ [auto-sync from adamlui/minify.js]

Author: adamlui

minify.js/node.js/src/cli.js

@@ -1,5 +1,7 @@
 #!/usr/bin/env node
 
+const docURL = 'https://docs.minify-js.org/#-command-line-usage';
+
 // Import LIBS
 const minifyJS = require(__dirname.match(/src/) ? './minify' : './minify.min'),
       fs = require('fs'),
@@ -37,16 +39,15 @@ process.argv.forEach(arg => {
     else if (matchedParamOption) {
         if (!arg.includes('=')) {
             console.error(`\n${br}ERROR: Arg [--${arg.replace(/-/g, '')}] requires '=' followed by a value.${nc}`);
-            console.error(`\n${by}For more help, type 'minify-js --help'.${nc}`);
-            process.exit(1);
+            printHelpCmdAndDocURL(); process.exit(1);
         }
         const value = arg.split('=')[1];
         config[matchedParamOption] = parseInt(value) || value;
     } else if (!matchedInfoCmd) {
         console.error(`\n${br}ERROR: Arg [${ arg }] not recognized.${nc}`);
         console.info(`\n${by}Valid arguments are below.${nc}`);
         printHelpSections(['paramOptions', 'flags', 'infoCmds']);
-        process.exit(1);
+        printHelpCmdAndDocURL(); process.exit(1);
 }});
 
 // Show HELP screen if -h or --help passed
@@ -70,9 +71,8 @@ else { // run MAIN routine
     if (inputArg && !fs.existsSync(inputPath)) {
         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);
+            + `\n\n${bg}Example valid command: \n» minify-js . output.min.js${nc}`);
+        printHelpCmdAndDocURL(); process.exit(1);
     }
 
     // Find all eligible JavaScript files or arg-passed file
@@ -193,4 +193,7 @@ function printHelpSections(
     }
 }
 
+function printHelpCmdAndDocURL() {
+    console.info(`\n${by}For more help, type 'minify-js --help' or visit\n${docURL + nc}`); }
+
 function printIfNotQuiet(msg) { if (!config.quietMode) console.info(msg); }

minify.js/node.js/src/minify.js

@@ -13,7 +13,9 @@ const fs = require('fs'),
 
 function findJS(searchDir, options = {}) {
 
-    const exampleCall = 'findJS(\'assets/js\', { verbose: false, dotFolders: true })';
+    const docURL = 'https://docs.minify-js.org/#findjssearchdir-options',
+          exampleCall = 'findJS(\'assets/js\', { verbose: false, dotFoldes: true })';
+
     const defaultOptions = {
         recursive: true,   // recursively search for nested files in searchDir passed
         verbose: true,     // enable logging
@@ -22,13 +24,16 @@ function findJS(searchDir, options = {}) {
     };
 
     // Validate searchDir
-    if (typeof searchDir !== 'string')
-        return console.error('findJS() » ERROR: 1st arg <searchDir> must be a string.');
-    else { // verify searchDir path existence
+    if (typeof searchDir !== 'string') {
+           console.error('findJS() » ERROR: 1st arg <searchDir> must be a string.');
+           console.info('findJS() » For more help, please visit ' + docURL);
+           return;
+    } else { // verify searchDir path existence
         const searchPath = path.resolve(process.cwd(), searchDir);
         if (!fs.existsSync(searchPath)) {
            console.error('findJS() » ERROR: 1st arg <searchDir> must be an existing directory.');
-           console.error(`findJS() » ${ searchPath } does not exist.`);
+           console.error(`findJS() » ${ searchPath } does not exist.`);           
+           console.info('findJS() » For more help, please visit ' + docURL);
            return;
     }}
 
@@ -64,7 +69,9 @@ function findJS(searchDir, options = {}) {
 
 function minify(input, options = {}) {
 
-    const exampleCall = 'minify(\'assets/js\', { recursive: false, mangle: false })';
+    const docURL = 'https://docs.minify-js.org/#minifyinput-options',
+          exampleCall = 'minify(\'assets/js\', { recursive: false, mangle: false })';
+
     const defaultOptions = {
         recursive: true,   // recursively search for nested files if dir path passed
         verbose: true,     // enable logging
@@ -75,8 +82,11 @@ function minify(input, options = {}) {
     };
 
     // Validate input
-    if (typeof input !== 'string') return console.error(
-        'minify() » ERROR: 1st arg <input> must be a string.');
+    if (typeof input !== 'string') {
+        console.error('minify() » ERROR: 1st arg <input> must be a string.');
+        console.info('minify() » For more help, please visit ' + docURL);
+        return;
+    }
 
     // Validate/init options
     if (!validateOptions(options, defaultOptions, exampleCall)) return;
@@ -127,37 +137,47 @@ function minify(input, options = {}) {
 // Define INTERNAL validation function
 
 function validateOptions(options, defaultOptions, exampleCall) {
-    const logPrefix = ( validateOptions.caller?.name || 'validateOptions' ) + '() » ';
+
+    const docURL = 'https://docs.minify-js.org/#-api-usage';
+
+    // Init option strings/types
     const strDefaultOptions = JSON.stringify(defaultOptions, null, 2)
         .replace(/"([^"]+)":/g, '$1:') // strip quotes from keys
         .replace(/"/g, '\'') // replace double quotes w/ single quotes
         .replace(/\n\s*/g, ' '); // condense to single line
     const strValidOptions = Object.keys(defaultOptions).join(', '),
           booleanOptions = Object.keys(defaultOptions).filter(key => typeof defaultOptions[key] === 'boolean'),
           integerOptions = Object.keys(defaultOptions).filter(key => Number.isInteger(defaultOptions[key]));
+
+    // Define print functions
+    const logPrefix = ( validateOptions.caller?.name || 'validateOptions' ) + '() » ';
     const printValidOptions = () => {
         console.info(`${ logPrefix }Valid options: [ ${ strValidOptions } ]`);
         console.info(`${ logPrefix }If omitted, default settings are: ${ strDefaultOptions }`);
     };
+    const printDocURL = () => {
+        console.info(`${ logPrefix }For more help, please visit ${docURL}`); };
+
+    // Validate options
     if (typeof options != 'object') { // validate as obj
         console.error(`${ logPrefix }ERROR: [options] can only be an object of key/values.`);
         console.info(`${ logPrefix }Example valid call: ${ exampleCall }`);
-        printValidOptions(); return false;
+        printValidOptions(); printDocURL(); return false;
     }
     for (const key in options) { // validate each key
         if (key != 'isRecursing' && !Object.prototype.hasOwnProperty.call(defaultOptions, key)) {
             console.error(
                 `${ logPrefix }ERROR: \`${ key }\` is an invalid option.`);
-            printValidOptions(); return false;
+            printValidOptions(); printDocURL(); return false;
         } else if (booleanOptions.includes(key) && typeof options[key] !== 'boolean') {
             console.error(
                 `${ logPrefix }ERROR: [${ key }] option can only be \`true\` or \`false\`.`);
-            return false;
+            printDocURL(); return false;
         } else if (integerOptions.includes(key)) {
             options[key] = parseInt(options[key], 10);
             if (isNaN(options[key]) || options[key] < 1) {
                 console.error(`${ logPrefix }ERROR: [${ key }] option can only be an integer > 0.`);
-                return false;
+                printDocURL(); return false;
             }
         }
     }