img-reducer-tool 1.0.0

package/README.md

@@ -0,0 +1,89 @@
+# Image Reducer Tool
+
+CLI tool for optimizing image file sizes while maintaining quality.
+
+## Installation
+```bash
+npm install -g img-reducer-tool
+```
+
+## Usage
+```bash
+img-reducer-tool -i <input> -q <quality> -s <size> [options]
+```
+
+## Parameters
+
+### `-i <file | folder | all>` (Required)
+Input source for image optimization:
+- **Single image file**: Path to a specific image
+- **Folder**: Directory containing images to process
+- **"all"**: Process all images in current directory
+
+### `-q <1-100>` (Required)
+Initial compression quality:
+- Higher values preserve more quality
+- Lower values reduce file size more aggressively
+- Minimum value is 1
+
+### `-s <size>` (Required)
+Maximum target size in KB:
+- Example: `1000` = 1 MB
+- Tool will attempt to reach closest possible size if target cannot be met
+
+### `-format <jpg|jpeg|png|webp|avif>` (Optional)
+Convert image to different format during optimization
+
+### `-overwrite` (Optional)
+Replace original file:
+- **Default behavior**: Creates new file with "-reduced" suffix
+- **With flag**: Removes original and keeps optimized version only
+
+## Supported Formats
+
+- JPG / JPEG
+- PNG
+- WebP
+- AVIF
+
+## Examples
+
+**Optimize single image:**
+```bash
+img-reducer-tool -i photo.png -q 80 -s 800
+```
+
+**Convert format:**
+```bash
+img-reducer-tool -i photo.png -q 80 -s 500 -format webp
+```
+
+**Process folder:**
+```bash
+img-reducer-tool -i ./images -q 70 -s 600
+```
+
+**Process all images in current directory:**
+```bash
+img-reducer-tool -i all -q 75 -s 700
+```
+
+**Overwrite original file:**
+```bash
+img-reducer-tool -i photo.jpg -q 70 -s 500 -overwrite
+```
+
+## Important Notes
+
+- Minimum quality value is 1
+- Closest possible size will be used if target cannot be met
+- Files with "-reduced" suffix are automatically skipped
+- Overwrite mode removes the original file permanently
+
+## License
+
+MIT
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.

package/bin/imgreducer.js

@@ -0,0 +1,132 @@
+#!/usr/bin/env node
+import { reduceImageHelper } from "../src/reduce.js";
+import { resolveImages } from "../src/files.js";
+import path from "path";
+import { errorFormatNotSupported, errorUnexpected, banner, line, showConfig, showSuccess, errorMissingParams, errorImageRequired, errorInvalidQuality, errorInvalidSize, errorFileNotFound, showMultipleSuccess, showProcessing, showGeneralInfo } from "../src/console.js";
+
+const args = process.argv.slice(2);
+const VALID_FORMATS = ["jpg", "jpeg", "png", "webp", "avif"];
+
+if (args[0] == "--info") {
+    showGeneralInfo()
+    process.exit(1);
+}
+
+let values = {
+    images: [],
+    quality: 0,
+    size: 0,
+    format: "",
+    overwrite: false
+};
+
+banner();
+
+if (args.length < 6) {
+    errorMissingParams();
+    process.exit(1);
+}
+
+for (let i = 0; i < args.length; i++) {
+    const arg = args[i];
+
+    if (arg === "-i") {
+        i++;
+        while (args[i] && !args[i].startsWith("-")) {
+            values.images.push(args[i]);
+            i++;
+        }
+        i--;
+        continue;
+    }
+
+    if (arg === "-q") values.quality = Number(args[i + 1]);
+    if (arg === "-s") values.size = Number(args[i + 1]);
+    if (arg === "-format") values.format = args[i + 1];
+    if (arg === "-overwrite") values.overwrite = true;
+}
+
+
+if (values.format && !VALID_FORMATS.includes(values.format)) {
+    errorFormatNotSupported(values.format)
+    process.exit(1);
+}
+
+if (!values.images.length) {
+    errorImageRequired();
+    process.exit(1);
+}
+
+if (!values.quality || values.quality < 1 || values.quality > 100) {
+    errorInvalidQuality();
+    process.exit(1);
+}
+
+if (!values.size || values.size <= 0) {
+    errorInvalidSize();
+    process.exit(1);
+}
+
+let images = [];
+
+try {
+    if (values.images.length === 1 && values.images[0] === "all") {
+        images = resolveImages("all");
+    } else {
+        images = values.images.flatMap(img => resolveImages(img));
+    }
+} catch (err) {
+    if (err.message === "FILE_NOT_FOUND") {
+        errorFileNotFound();
+        process.exit(1);
+    }
+    throw err;
+}
+
+showConfig({
+    image: images.length === 1
+        ? path.basename(images[0])
+        : `${images.length} images`,
+    quality: values.quality,
+    size: values.size,
+    format: values.format,
+    overwrite: values.overwrite,
+});
+
+const isMultiple = images.length > 1;
+let index = 1;
+const results = [];
+
+showProcessing(images.length)
+
+for (const imagePath of images) {
+    try {
+        const result = await reduceImageHelper({
+            imagePath,
+            quality: values.quality,
+            size: values.size,
+            format: values.format,
+            overwrite: values.overwrite,
+        });
+
+        console.log(`[${index}/${images.length}] ${result.input}`);
+
+        if (!isMultiple) {
+            showSuccess(result.output, result.finalSizeKB);
+        } else {
+            results.push({
+                output: result.output,
+                finalSizeKB: result.finalSizeKB
+            });
+            index++;
+        }
+
+    } catch (err) {
+        errorUnexpected(err.message)
+        line();
+    }
+}
+
+if (isMultiple) {
+    showMultipleSuccess(results);
+}

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "img-reducer-tool",
+  "version": "1.0.0",
+  "type": "module",
+  "bin": {
+    "img-reducer-tool": "bin/imgreducer.js"
+  },
+  "dependencies": {
+    "chalk": "^5.6.2",
+    "sharp": "^0.34.5"
+  },
+  "description": "CLI tool for optimizing image file sizes while maintaining quality.",
+  "devDependencies": {},
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": ["image", "compress", "cli", "sharp"],
+  "author": "William Molina",
+  "license": "ISC"
+}

package/src/console.js

@@ -0,0 +1,216 @@
+import chalk from 'chalk';
+
+const colors = {
+    primary: chalk.cyan,
+    success: chalk.green,
+    error: chalk.red,
+    warning: chalk.yellow,
+    muted: chalk.gray,
+    bold: chalk.bold,
+    dim: chalk.dim
+};
+
+const symbols = {
+    success: '✓',
+    error: '✗',
+    info: 'ℹ',
+    arrow: '→',
+    bullet: '•'
+};
+
+export const banner = () => {
+    console.log(colors.success(`
+██████ ▄██▄▄██▄ ▄████▄ ▄██████ ▄█████   ████████ ▄█████▄ ▄█████▄ ██    
+  ██   ██ ██ ██ ██  ██ ██      ██          ██    ██   ██ ██   ██ ██    
+  ██   ██ ██ ██ ██  ██ ██  ███ █████       ██    ██   ██ ██   ██ ██    
+  ██   ██ ██ ██ ██████ ██   ██ ██          ██    ██   ██ ██   ██ ██    
+██████ ██ ██ ██ ██  ██ ▀█████▀ ▀█████      ██    ▀█████▀ ▀█████▀ ██████
+`));
+    console.log(colors.success('Version 1.0.0'));
+};
+
+export const line = () => {
+    console.log(colors.muted('─'.repeat(60)));
+};
+
+export const section = (title) => {
+    console.log('');
+    console.log(colors.bold(title));
+    line();
+};
+
+export const errorMissingParams = () => {
+    console.log('');
+    console.log(colors.error(`${symbols.error} Missing required parameters`));
+    console.log('');
+    console.log('Usage:');
+    console.log(colors.muted('  img-reducer-tool -i <image> -q <quality> -s <size>'));
+    console.log('');
+    console.log('Required parameters:');
+    console.log(`  ${colors.bold('-i')}  ${colors.dim('Image file path')}`);
+    console.log(`  ${colors.bold('-q')}  ${colors.dim('Quality (1-100)')}`);
+    console.log(`  ${colors.bold('-s')}  ${colors.dim('Target size in KB')}`);
+    console.log('');
+    console.log(colors.muted('Run --info for detailed documentation'));
+    console.log('');
+};
+
+export const errorImageRequired = () => {
+    console.log('');
+    console.log(colors.error(`${symbols.error} Image path is required`));
+    console.log(colors.muted('  Use -i to specify an image file'));
+    console.log('');
+};
+
+export const errorFormatNotSupported = (format) => {
+    console.log('');
+    console.log(colors.error(`${symbols.error} This format is not supported: ${format}`));
+
+    section('Supported Formats');
+    console.log('jpg, jpeg, png, webp, avif');
+    console.log('');
+    console.log(colors.muted('Run --info for detailed documentation'));
+    console.log('');
+};
+
+export const errorUnexpected = (error) => {
+    console.log('');
+    console.log(colors.error(`Unexpected error: ${error}`));
+    console.log('');
+    console.log(colors.muted('Run --info for detailed documentation'));
+    console.log('');
+};
+
+export const errorInvalidQuality = () => {
+    console.log('');
+    console.log(colors.error(`${symbols.error} Invalid quality value`));
+    console.log(colors.muted('  Quality must be between 1 and 100'));
+    console.log('');
+    console.log(colors.muted('Run --info for detailed documentation'));
+    console.log('');
+};
+
+export const errorInvalidSize = () => {
+    console.log('');
+    console.log(colors.error(`${symbols.error} Invalid size value`));
+    console.log(colors.muted('  Size must be greater than 0 (in KB)'));
+    console.log('');
+    console.log(colors.muted('Run --info for detailed documentation'));
+    console.log('');
+};
+
+export const errorFileNotFound = () => {
+    console.log('');
+    console.log(colors.error(`${symbols.error} Image file not found`));
+    console.log(colors.muted('  Please verify the file path'));
+    console.log('');
+    console.log(colors.muted('Run --info for detailed documentation'));
+    console.log('');
+};
+
+export const showConfig = ({ image, quality, size, format, overwrite }) => {
+    section('Configuration');
+    console.log(`File:            ${colors.primary(image)}`);
+    console.log(`Quality:         ${colors.primary(quality + '%')}`);
+    console.log(`Target size:     ${colors.primary(size + ' KB')}`);
+    console.log(`Format change:   ${format ? colors.success('Yes') : colors.muted('No')}`);
+    console.log(`Overwrite:       ${overwrite ? colors.warning('Yes') : colors.muted('No')}`);
+    line();
+};
+
+export const showProcessing = (length) => {
+    const imageText = length === 1 ? 'image' : 'images';
+    console.log(colors.muted(`Processing ${length} ${imageText}...`));
+    console.log('');
+};
+
+export const showSuccess = (file, sizeKB) => {
+    line();
+    console.log(colors.success(`${symbols.success} Completed successfully`));
+    console.log('');
+    console.log('Output:');
+    console.log(`${symbols.bullet} ${colors.bold(file)} ${colors.muted(symbols.arrow)} ${colors.primary(Math.round(sizeKB) + ' KB')}`);
+    line();
+};
+
+export const showMultipleSuccess = (files) => {
+    line();
+    console.log(colors.success(`${symbols.success} Completed successfully`));
+    console.log('');
+    console.log(`Output files (${files.length}):`);
+
+    for (const file of files) {
+        console.log(`${symbols.bullet} ${colors.bold(file.output)} ${colors.muted(symbols.arrow)} ${colors.primary(Math.round(file.finalSizeKB) + ' KB')}`);
+    }
+
+    console.log('');
+    line();
+};
+
+export const showGeneralInfo = () => {
+    banner();
+
+    section('Overview');
+    console.log('CLI tool for optimizing image file sizes while maintaining quality.');
+    console.log('');
+
+    section('Parameters');
+
+    console.log(colors.bold('  -i') + colors.dim(' <file | folder | all>'));
+    console.log('     Single image file');
+    console.log('     Folder containing images');
+    console.log('     "all" for current directory');
+    console.log('');
+
+    console.log(colors.bold('  -q') + colors.dim(' <1-100>'));
+    console.log('     Initial compression quality');
+    console.log('     Higher values preserve more quality');
+    console.log('');
+
+    console.log(colors.bold('  -s') + colors.dim(' <size>'));
+    console.log('     Maximum target size in KB');
+    console.log('     Example: 1000 = 1 MB');
+    console.log('');
+
+    console.log(colors.bold('  -format') + colors.dim(' <jpg|jpeg|png|webp|avif>'));
+    console.log('     Convert to different format (optional)');
+    console.log('');
+
+    console.log(colors.bold('  -overwrite'));
+    console.log('     Replace original file');
+    console.log('     Default: creates "-reduced" suffix');
+    console.log('');
+
+    section('Supported Formats');
+    console.log('  jpg, jpeg, png, webp, avif');
+    console.log('');
+
+    section('Examples');
+
+    console.log(colors.dim('  Optimize single image:'));
+    console.log('    img-reducer-tool -i photo.png -q 80 -s 800');
+    console.log('');
+
+    console.log(colors.dim('  Convert format:'));
+    console.log('    img-reducer-tool -i photo.png -q 80 -s 500 -format webp');
+    console.log('');
+
+    console.log(colors.dim('  Process folder:'));
+    console.log('    img-reducer-tool -i ./images -q 70 -s 600');
+    console.log('');
+
+    console.log(colors.dim('  Process all images:'));
+    console.log('    img-reducer-tool -i all -q 75 -s 700');
+    console.log('');
+
+    console.log(colors.dim('  Overwrite original:'));
+    console.log('    img-reducer-tool -i photo.jpg -q 70 -s 500 -overwrite');
+    console.log('');
+
+    section('Notes');
+    console.log(`  ${symbols.bullet} Minimum quality value is 1`);
+    console.log(`  ${symbols.bullet} Closest possible size will be used if target cannot be met`);
+    console.log(`  ${symbols.bullet} Files with "-reduced" suffix are skipped`);
+    console.log(`  ${symbols.bullet} Overwrite mode removes the original file`);
+    line();
+};

package/src/files.js

@@ -0,0 +1,43 @@
+import fs from "fs";
+import path from "path";
+
+const VALID_EXTENSIONS = [".jpg", ".jpeg", ".png", ".webp", ".avif"];
+
+export const resolveImages = (input) => {
+    const cwd = process.cwd();
+    const fullPath = path.resolve(cwd, input);
+
+    if (input === "all") {
+        return fs
+            .readdirSync(cwd)
+            .filter(file => {
+                const ext = path.extname(file).toLowerCase();
+                return (
+                    VALID_EXTENSIONS.includes(ext) &&
+                    !file.includes("-reduced")
+                );
+            })
+            .map(file => path.join(cwd, file));
+    }
+
+    if (!fs.existsSync(fullPath)) {
+        throw new Error("FILE_NOT_FOUND");
+    }
+
+    const stats = fs.statSync(fullPath);
+
+    if (stats.isDirectory()) {
+        return fs
+            .readdirSync(fullPath)
+            .filter(file => {
+                const ext = path.extname(file).toLowerCase();
+                return (
+                    VALID_EXTENSIONS.includes(ext) &&
+                    !file.includes("-reduced")
+                );
+            })
+            .map(file => path.join(fullPath, file));
+    }
+
+    return [fullPath];
+};

package/src/reduce.js

@@ -0,0 +1,85 @@
+// src/reduce.js
+import fs from "fs";
+import path from "path";
+import sharp from "sharp";
+
+export const reduceImageHelper = async ({ imagePath, quality, size, format, overwrite }) => {
+    const imageBuffer = fs.readFileSync(imagePath);
+    const originalSizeKB = imageBuffer.length / 1024;
+
+    const inputExt = path.extname(imagePath);
+    const dir = path.dirname(imagePath);
+
+    const rawName = path.basename(imagePath, inputExt).replace(/-reduced$/, "");
+    const targetFormat = (format || inputExt.replace(".", "")).toLowerCase();
+    const outputExt = `.${targetFormat}`;
+
+    const outputName = overwrite
+        ? `${rawName}${outputExt}`
+        : `${rawName}-reduced${outputExt}`;
+
+    const outputPath = path.join(dir, outputName);
+
+    let currentQuality = quality;
+    let outputBuffer = imageBuffer;
+    let outputSizeKB = originalSizeKB;
+
+    while (outputSizeKB > size && currentQuality > 1) {
+        let pipeline = sharp(imageBuffer);
+
+        switch (targetFormat) {
+            case "jpg":
+            case "jpeg":
+                pipeline = pipeline.jpeg({
+                    quality: currentQuality,
+                    mozjpeg: true
+                });
+                break;
+            case "png":
+                pipeline = pipeline.png({
+                    compressionLevel: 9,
+                    quality: currentQuality,
+                });
+                break;
+            case "webp":
+                pipeline = pipeline.webp({
+                    quality: currentQuality,
+                    effort: 6
+                });
+                break;
+            case "avif":
+                pipeline = pipeline.avif({
+                    quality: currentQuality,
+                    effort: 9
+                });
+                break;
+            default:
+                throw new Error("UNSUPPORTED_FORMAT");
+        }
+
+        outputBuffer = await pipeline.toBuffer();
+        outputSizeKB = outputBuffer.length / 1024;
+
+        if (outputSizeKB > size * 2) {
+            currentQuality -= 10;
+        } else if (outputSizeKB > size * 1.5) {
+            currentQuality -= 5;
+        } else {
+            currentQuality -= 2;
+        }
+    }
+
+    fs.writeFileSync(outputPath, outputBuffer);
+
+    if (overwrite && outputPath !== imagePath) {
+        fs.unlinkSync(imagePath);
+    }
+
+    return {
+        input: path.basename(imagePath),
+        output: outputName,
+        originalSizeKB,
+        finalSizeKB: outputSizeKB,
+        overwritten: overwrite
+    };
+};