@adamlui/minify.js 1.2.1 → 1.2.3

package/README.md

@@ -4,7 +4,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&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.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=versions"><img height=31 src="https://img.shields.io/badge/Latest_Build-1.2.3-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">
@@ -32,15 +32,17 @@ npm install -D @adamlui/minify.js
 The basic **global command** is:
 
 ```
-minifyjs
+minify-js
 ```
 
+**💡 Note:** Pass `-n` or `--dry-run` to only see what files will be processed.
+
 #
 
 To specify **input/output** paths:
    
 ```
-minifyjs [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. 
@@ -50,15 +52,15 @@ minifyjs [input_path] [output_path]
 
 #
 
-To use as a **package script**, edit your project's `package.json` like this:
+To use as a **package script**, in your project's `package.json`:
 
 ```json
   "scripts": {
-    "build:js": "<minify.js-cmd>"
+    "build:js": "<minify-js-cmd>"
   },
 ```
 
-Replace `<minify.js-cmd>` with `minifyjs` + optional args. Then, `npm run build:js` can be used to run the command.
+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:
@@ -66,27 +68,32 @@ Replace `<minify.js-cmd>` with `minifyjs` + optional args. Then, `npm run build:
 - Minify all JavaScript files in the **current directory** (outputs to `min/`):
 
    ```
-   minifyjs
+   minify-js
    ```
 
 - Minify all JavaScript files in a **specific directory** (outputs to `path/to/your/directory/min/`):
 
    ```
-   minifyjs path/to/your/directory
+   minify-js path/to/your/directory
    ```
 
 - Minify a **specific file** (outputs to `path/to/your/min/file.min.js`):
 
    ```
-   minifyjs path/to/your/file.js
+   minify-js path/to/your/file.js
    ```
 
 - Specify both **input and output** directories (outputs to `output_folder/`):
 
    ```
-   minifyjs input_folder output_folder
+   minify-js input_folder output_folder
    ```
 
+## 💖 Support
+
+Please consider giving a ⭐ on [GitHub](https://github.com/adamlui/js-utils) if this helped you!
+<br><br>
+
 ## 🏛️ MIT License
 
 **Copyright (c) 2024 [Adam Lui](https://github.com/adamlui)**

package/minify.js

@@ -15,7 +15,7 @@ const nc = '\x1b[0m', // no color
 if (process.argv.some(arg => /^--?h(?:elp)?$/.test(arg))) {
 
     // Print help
-    console.info(`\n${by}minifyjs [inputPath] [outputPath] [options]${nc}`);
+    console.info(`\n${by}minify-js [inputPath] [outputPath] [options]${nc}`);
     console.info('\nPath arguments:');
     printWrappedMsg(' [inputPath]                 '
         + 'Path to JS file or directory containing JS files to be minified,'
@@ -24,6 +24,8 @@ if (process.argv.some(arg => /^--?h(?:elp)?$/.test(arg))) {
         + '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(' -n, --dry-run               Don\'t actually minify the file(s),'
+        + ' just show if they will be processed.');
     printWrappedMsg(' -dd, --include-dotfolders   Include dotfolders in file search.');
     printWrappedMsg(' -df, --include-dotfilles    Include dotfiles in file search.');
     console.info('\nInfo commands:');
@@ -48,12 +50,14 @@ if (process.argv.some(arg => /^--?h(?:elp)?$/.test(arg))) {
     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');
+            + `\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);
     }
 
     // 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?)$/.test(arg)),
         includeDotFiles: process.argv.some(arg =>
@@ -61,52 +65,61 @@ if (process.argv.some(arg => /^--?h(?:elp)?$/.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 unminnedJSfiles = [];
+    if (inputArg.endsWith('.js')) unminnedJSfiles.push(inputPath);
+    else (function findUnminnedJSfiles(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
+                    findUnminnedJSfiles(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
+                    unminnedJSfiles.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++;
-    });
+    if (unminnedJSfiles.length === 0) { // print nothing found
+        console.info(`\n${by}No unminified JavaScript files found.${nc}`);
+
+    } else if (config.dryRun) { // print files to be processed
+        console.info(`\n${by}JS files to be minified:${nc}`);
+        unminnedJSfiles.forEach(file => console.info(file));
+
+    } else { // actually minify JavaScript files
 
-    // 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}`);
+        let minifiedCnt = 0;
+        console.log(''); // line break before first log
+        unminnedJSfiles.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 processed successfully.${nc}`);
+    }
 }
 
-function printWrappedMsg(msg) { // truncates msg, indents 2nd+ lines
+function printWrappedMsg(msg) { // wraps msg, indents 2nd+ lines
     const terminalWidth = process.stdout.columns || 80,
           indentation = 29, lines = [], words = msg.match(/\S+|\s+/g);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adamlui/minify.js",
-  "version": "1.2.1",
+  "version": "1.2.3",
   "description": "Recursively minify all JavaScript files",
   "author": {
     "name": "Adam Lui",