@adamlui/minify.js 1.0.0

package/README.md

@@ -0,0 +1,107 @@
+# <> minify.js 
+
+<a href="#%EF%B8%8F-mit-license"><img height=25 src="https://img.shields.io/badge/License-MIT-fcde7b.svg?logo=internetarchive&logoColor=white&labelColor=464646&style=for-the-badge"></a>
+
+### Minify JavaScript files from the CLI (recursively or indivdually)
+
+<img height=10px width="100%" src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/aqua.png">
+
+## ⚡ Installation
+
+- As a **global utility**:
+
+   ```
+   npm install -g @adamlui/minify.js
+   ```
+
+- As a **dev dependency**, from your project root:
+
+   ```
+   npm install -D @adamlui/minify.js
+   ```
+
+## 💻 Usage
+
+- The basic **global command** is:
+
+   ```
+   minify-js
+   ```
+
+- To specify **input/output** directories:
+   
+   ```
+   minify-js <input_path> <output_path>
+   ```
+   
+   - `<input_path>`: Path to directory containing JavaScript files to be minified, relative to the current working directory. 
+   - `<output_path>`: Path to directory where minified files will be stored, relative to original file location. (If not provided, `./minified` is used.)
+
+   **💡 Note:** The paths can be either folders or specific files. If folders are passed, files will be processed recursively.<br><br>
+
+- To use as a **package script**, edit your project's `package.json` like this:
+
+   ```json
+     "scripts": {
+       "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.
+   <br><br>
+
+## 📃 Examples:
+
+- Minify all JavaScript files in the **current directory** (outputs to `./minified/`):
+
+   ```
+   minify-js
+   ```
+
+- Minify all JavaScript files in a **specific directory** (outputs to `path/to/your/directory/minified/`):
+
+   ```
+   minify-js path/to/your/directory
+   ```
+
+- Minify a **specific file** (outputs to `path/to/your/minified/file.min.js`):
+
+   ```
+   minify-js path/to/your/file.js
+   ```
+
+- Specify both **input and output** directories (outputs to `output_folder/`):
+
+   ```
+   minify-js input_folder output_folder
+   ```
+
+## 🏛️ MIT License
+
+**Copyright (c) 2024 [Adam Lui](https://github.com/adamlui)**
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+<br>
+
+<img height=6px width="100%" src="https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/aqua.png">
+
+<a href="https://github.com/adamlui">**Home**</a> /
+<a href="https://github.com/adamlui/js-utils/discussions">Discuss</a> /
+<a href="#--scss-to-cssjs">Back to top ↑</a>

package/docs/LICENSE.md

@@ -0,0 +1,21 @@
+# MIT License
+
+**Copyright (c) 2023–2024 [Adam Lui](https://github.com/adamlui)**
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/docs/SECURITY.md

@@ -0,0 +1,5 @@
+# 🛡️ Security Policy
+
+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.

package/minify.js

@@ -0,0 +1,65 @@
+#!/usr/bin/env node
+
+// Import libs
+const fs = require('fs'),
+      path = require('path'),
+      uglifyJS = require('uglify-js');
+
+// Init UI colors
+const nc = '\x1b[0m', // no color
+      br = '\x1b[1;91m', // bright red
+      by = '\x1b[1;33m', // bright yellow
+      bg = '\x1b[1;92m'; // bright green
+
+// Clean leading slashes from args to avoid parsing system root
+const inputArg = process.argv[2] ? process.argv[2].replace(/^\/*/, '') : '',
+      outputArg = process.argv[3] ? process.argv[3].replace(/^\/*/, '') : '';
+
+// Validate input arg (output arg can be anything)
+if (process.argv[2] && !fs.existsSync(inputArg)) {
+    console.error(`\n${br}Error: First arg must be an existing file or path.${nc}`
+        + '\nExample valid command: \n>> minify-js . output.min.js');
+    process.exit(1);
+}
+
+// Recursively find all JavaScript files or arg-passed file
+const inputPath = path.resolve(process.cwd(), inputArg);
+const jsFiles = inputArg.endsWith('.js') ? [inputPath]
+  : (() => {
+        const fileList = [];
+        (function findJSfiles(dir) {
+            const files = fs.readdirSync(dir);
+            files.forEach(file => {
+                const filePath = path.join(dir, file);
+                if (fs.statSync(filePath).isDirectory())
+                    findJSfiles(filePath); // recursively find unminified JS
+                else if (/\.js(?<!\.min\.js)$/.test(file)) // unminified JS file found
+                    fileList.push(filePath); // store it for minification
+            });
+        })(inputPath); return fileList;
+    })();
+
+// Minify JavaScript files
+let minifiedCnt = 0;
+console.log(''); // line break before first log
+jsFiles.forEach(jsPath => {
+    const outputDir = path.join(
+        path.dirname(jsPath), // path of file to be minified
+        path.dirname(outputArg), // path from output arg
+        outputArg ? '' : 'minified' // minified/ if no output arg used
+    );
+    const outputFilename = (
+        outputArg.endsWith('.js') && inputArg.endsWith('.js')
+            ? path.basename(outputArg).replace(/(\.min)?\.js$/, '')
+            : path.basename(jsPath, '.js')
+    ) + '.min.js';
+    console.info(`Minifying ${ jsPath }...`);
+    const minifiedCode = uglifyJS.minify(fs.readFileSync(jsPath, 'utf8')).code;
+    if (!fs.existsSync(outputDir)) fs.mkdirSync(outputDir, { recursive: true });
+    fs.writeFileSync(path.join(outputDir, outputFilename), minifiedCode, 'utf8');
+    minifiedCnt++;
+});
+
+// Final summary
+if (minifiedCnt) console.info(`\n${bg}Minification complete!${nc}\n${ minifiedCnt } files minified.`);
+else console.info(`\n${by}No unminified JavaScript files found.${nc}`);

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@adamlui/minify.js",
+  "version": "1.0.0",
+  "description": "Minify JavaScript files",
+  "author": {
+    "name": "Adam Lui",
+    "email": "adam@kudoai.com",
+    "url": "https://github.com/adamlui"
+  },
+  "homepage": "https://github.com/adamlui/js-utils",
+  "license": "MIT",
+  "main": "minify.js",
+  "bin": {
+    "minify-js": "minify.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/adamlui/js-utils.git"
+  },
+  "keywords": [
+    "javascript",
+    "js",
+    "js-utils",
+    "utils",
+    "utilities",
+    "minifier"
+  ],
+  "bugs": {
+    "url": "https://github.com/adamlui/js-utils/issues"
+  },
+  "dependencies": {
+    "uglify-js": "^3.17.4"
+  }
+}