@adamlui/minify.js 1.1.2 → 1.2.1

package/README.md

@@ -1,12 +1,13 @@
-# <> minify.js 
+# </> minify.js 
 
 ### 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=46464&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&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-fcde7b.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.1.2-fc7811.svg?logo=icinga&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.2.1-fc7811.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"></a>
 
-<img src="https://github.com/adamlui/js-utils/blob/main/minify.js/media/images/minify-js-docs-demo.png">
+<img src="https://github.com/adamlui/js-utils/blob/main/minify.js/media/images/minify.js-docs-demo.png">
 
 <br>
 
@@ -31,7 +32,7 @@ npm install -D @adamlui/minify.js
 The basic **global command** is:
 
 ```
-minify-js
+minifyjs
 ```
 
 #
@@ -39,13 +40,13 @@ minify-js
 To specify **input/output** paths:
    
 ```
-minify-js <input_path> <output_path>
+minifyjs [input_path] [output_path]
 ```
 
-- `<input_path>`: Path to JS file or directory containing JS files to be minified, relative to the current working directory. 
-- `<output_path>`: Path to file or directory where minified files will be stored, relative to original file location (if not provided, `min/` is used).
+- `[input_path]`: Path to JS file or directory containing JS files to be minified, relative to the current working directory. 
+- `[output_path]`: Path to file or directory where minified files will be stored, relative to original file location (if not provided, `min/` is used).
 
-**💡 Note:** If folders are passed, files will be processed recursively. To include dotfolders, pass `--include-dotfolders`. To include dotfiles, pass `--include-dotfiles`.
+**💡 Note:** If folders are passed, files will be processed recursively. To include dotfolders, pass `-dd` or `--include-dotfolders`. To include dotfiles, pass `-df` or `--include-dotfiles`.
 
 #
 
@@ -53,11 +54,11 @@ To use as a **package script**, edit your project's `package.json` like this:
 
 ```json
   "scripts": {
-    "build:js": "<minify-js-cmd>"
+    "build:js": "<minify.js-cmd>"
   },
 ```
 
-Replace `<minify-js-cmd>` with `minify-js` + optional args. Then, `npm run build:js` can be used to run the command.
+Replace `<minify.js-cmd>` with `minifyjs` + optional args. Then, `npm run build:js` can be used to run the command.
 <br><br>
 
 ## 📃 Example commands:
@@ -65,25 +66,25 @@ Replace `<minify-js-cmd>` with `minify-js` + optional args. Then, `npm run build
 - Minify all JavaScript files in the **current directory** (outputs to `min/`):
 
    ```
-   minify-js
+   minifyjs
    ```
 
 - Minify all JavaScript files in a **specific directory** (outputs to `path/to/your/directory/min/`):
 
    ```
-   minify-js path/to/your/directory
+   minifyjs path/to/your/directory
    ```
 
 - Minify a **specific file** (outputs to `path/to/your/min/file.min.js`):
 
    ```
-   minify-js path/to/your/file.js
+   minifyjs path/to/your/file.js
    ```
 
 - Specify both **input and output** directories (outputs to `output_folder/`):
 
    ```
-   minify-js input_folder output_folder
+   minifyjs input_folder output_folder
    ```
 
 ## 🏛️ MIT License

package/docs/SECURITY.md

@@ -2,4 +2,4 @@
 
 If you find a vulnerability, please open a [draft security advisory](https://github.com/adamlui/js-utils/security/advisories/new).
 
-Pull requests are also welcome, but for safety reasons, send an email to adam@kudoai.com and wait for a response before making it public.
+Pull requests are also welcome, but for safety reasons, send an email to <adam@kudoai.com> and wait for a response before making it public.

package/minify.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 
-// Import libs
+// Import LIBS
 const fs = require('fs'),
       path = require('path'),
       uglifyJS = require('uglify-js');
@@ -11,69 +11,120 @@ const nc = '\x1b[0m', // no color
       by = '\x1b[1;33m', // bright yellow
       bg = '\x1b[1;92m'; // bright green
 
-// Init I/O args
-const [inputArg = '', outputArg = ''] = ( // default to empty strings for error-less handling
-    process.argv.slice(2) // exclude executable and script paths
-        .filter(arg => !arg.startsWith('-')) // exclude flags
-        .map(arg => arg.replace(/^\/*/, '')) // clean leading slashes to avoid parsing system root
-);
+// Show HELP screen if -h or --help passed
+if (process.argv.some(arg => /^--?h(?:elp)?$/.test(arg))) {
 
-// 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 arg must be an existing file or directory.`
-        + `\n${ inputPath } does not exist.${nc}`
-        + '\n\nExample valid command: \n>> minify-js . output.min.js');
-    process.exit(1);
-}
+    // Print help
+    console.info(`\n${by}minifyjs [inputPath] [outputPath] [options]${nc}`);
+    console.info('\nPath arguments:');
+    printWrappedMsg(' [inputPath]                 '
+        + 'Path to JS file or directory containing JS files to be minified,'
+        + ' relative to the current working directory.');
+    printWrappedMsg(' [outputPath]                '
+        + 'Path to file or directory where minified files will be stored,'
+        + ' relative to original file location (if not provided, min/ is used).');
+    console.info('\nConfig options:');
+    printWrappedMsg(' -dd, --include-dotfolders   Include dotfolders in file search.');
+    printWrappedMsg(' -df, --include-dotfilles    Include dotfiles in file search.');
+    console.info('\nInfo commands:');
+    printWrappedMsg(' -h, --help                  Display this help screen.');
+    printWrappedMsg(' -v, --version               Show version number.');
 
-// Store flag settings
-const config = { 
-    includeDotFolders: process.argv.some(arg => /--?include-dot-?folders?/.test(arg)),
-    includeDotFiles: process.argv.some(arg => /--?include-dot-?files?/.test(arg))
-};
+// Show VERSION number if -v or --version passed
+} else if (process.argv.some(arg => /^--?ve?r?s?i?o?n?$/.test(arg))) {
+    console.info('v' + require('./package.json').version);
 
-// Recursively find all eligible JavaScript files or arg-passed file
-const jsFiles = [];
-if (inputArg.endsWith('.js')) jsFiles.push(inputPath);
-else (function findJSfiles(dir) {
-    const files = fs.readdirSync(dir);
-    files.forEach(file => {
-        const filePath = path.resolve(dir, file);
-        if (fs.statSync(filePath).isDirectory() && file != 'node_modules' &&
-            (config.includeDotFolders || !file.startsWith('.')))
-                findJSfiles(filePath); // recursively find unminified JS in eligible dir
-        else if (/\.js(?<!\.min\.js)$/.test(file) &&
-            (config.includeDotFiles || !file.startsWith('.')))
-                jsFiles.push(filePath); // store eligible unminified JS file for minification
-    });
-})(inputPath);
+} else { // run MAIN routine
 
-// Minify JavaScript files
-let minifiedCnt = 0;
-console.log(''); // line break before first log
-jsFiles.forEach(jsPath => {
-    console.info(`Minifying ${ jsPath }...`);
-    const outputDir = path.join(
-        path.dirname(jsPath), // path of file to be minified
-        /so?u?rce?$/.test(path.dirname(jsPath)) ? '../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
+    // Init I/O args
+    const [inputArg = '', outputArg = ''] = ( // default to empty strings for error-less handling
+        process.argv.slice(2) // exclude executable and script paths
+            .filter(arg => !arg.startsWith('-')) // exclude flags
+            .map(arg => arg.replace(/^\/*/, '')) // clean leading slashes to avoid parsing system root
     );
-    const outputFilename = (
-        outputArg.endsWith('.js') && inputArg.endsWith('.js')
-            ? path.basename(outputArg).replace(/(\.min)?\.js$/, '')
-            : path.basename(jsPath, '.js')
-    ) + '.min.js';
-    const outputPath = path.join(outputDir, outputFilename),
-          minifiedCode = uglifyJS.minify(fs.readFileSync(jsPath, 'utf8')).code;
-    if (!fs.existsSync(outputDir)) fs.mkdirSync(outputDir, { recursive: true });
-    fs.writeFileSync(outputPath, minifiedCode, 'utf8');
-    minifiedCnt++;
-});
 
-// Print final summary
-if (minifiedCnt) {
-    console.info(`\n${bg}Minification complete!${nc}`);
-    console.info(`${ minifiedCnt } file${ minifiedCnt > 1 ? 's' : '' } minified.`);
-} else console.info(`${by}No unminified JavaScript files found.${nc}`);
+    // 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 arg must be an existing file or directory.`
+            + `\n${ inputPath } does not exist.${nc}`
+            + '\n\nExample valid command: \n>> minifyjs . output.min.js');
+        process.exit(1);
+    }
+
+    // Load flag settings
+    const config = { 
+        includeDotFolders: process.argv.some(arg =>
+            /^--?(?:dd|(?:include-)?dot-?(?:folder|dir(?:ector(?:y|ie))?)s?)$/.test(arg)),
+        includeDotFiles: process.argv.some(arg =>
+            /^--?(?:df|(?:include-)?dot-?files?)$/.test(arg))
+    };
+
+    // Recursively find all eligible JavaScript files or arg-passed file
+    const jsFiles = [];
+    if (inputArg.endsWith('.js')) jsFiles.push(inputPath);
+    else (function findJSfiles(dir) {
+        const files = fs.readdirSync(dir);
+        files.forEach(file => {
+            const filePath = path.resolve(dir, file);
+            if (fs.statSync(filePath).isDirectory() && file != 'node_modules' &&
+                (config.includeDotFolders || !file.startsWith('.')))
+                    findJSfiles(filePath); // recursively find unminified JS in eligible dir
+            else if (/\.js(?<!\.min\.js)$/.test(file) &&
+                (config.includeDotFiles || !file.startsWith('.')))
+                    jsFiles.push(filePath); // store eligible unminified JS file for minification
+        });
+    })(inputPath);
+
+    // Minify JavaScript files
+    let minifiedCnt = 0;
+    console.log(''); // line break before first log
+    jsFiles.forEach(jsPath => {
+        console.info(`Minifying ${ jsPath }...`);
+        const outputDir = path.join(
+            path.dirname(jsPath), // path of file to be minified
+            /so?u?rce?$/.test(path.dirname(jsPath)) ? '../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
+        );
+        const outputFilename = (
+            outputArg.endsWith('.js') && inputArg.endsWith('.js')
+                ? path.basename(outputArg).replace(/(\.min)?\.js$/, '')
+                : path.basename(jsPath, '.js')
+        ) + '.min.js';
+        const outputPath = path.join(outputDir, outputFilename),
+              minifiedCode = uglifyJS.minify(fs.readFileSync(jsPath, 'utf8')).code;
+        if (!fs.existsSync(outputDir)) fs.mkdirSync(outputDir, { recursive: true });
+        fs.writeFileSync(outputPath, minifiedCode, 'utf8');
+        minifiedCnt++;
+    });
+
+    // Print final summary
+    if (minifiedCnt) {
+        console.info(`\n${bg}Minification complete!${nc}`);
+        console.info(`${ minifiedCnt } file${ minifiedCnt > 1 ? 's' : '' } minified.`);
+    } else console.info(`${by}No unminified JavaScript files found.${nc}`);
+}
+
+function printWrappedMsg(msg) { // truncates msg, indents 2nd+ lines
+    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
+    ));
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adamlui/minify.js",
-  "version": "1.1.2",
+  "version": "1.2.1",
   "description": "Recursively minify all JavaScript files",
   "author": {
     "name": "Adam Lui",
@@ -11,6 +11,7 @@
   "license": "MIT",
   "main": "minify.js",
   "bin": {
+    "minifyjs": "minify.js",
     "minify-js": "minify.js"
   },
   "scripts": {