micropng-cli 0.1.0

package/README.md

@@ -0,0 +1,96 @@
+# MicroPng CLI
+
+A high-performance, local-first CLI image compressor built with Node.js and libvips (via `sharp`). Supports recursive processing, atomic overwrites, and format conversion.
+
+[![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg)](https://opensource.org/licenses/ISC)
+
+## Features
+
+- 🚀 **Fast**: Parallel processing with smart concurrency control.
+- 📂 **Recursive**: Deeply scans folders and subfolders.
+- 🔄 **Safe Overwrite**: Atomic replacements to prevent data loss.
+- 🖼️ **Multi-Format**: Supports JPEG, PNG, WebP, AVIF.
+- 🔒 **Local-First**: No data leaves your machine.
+
+## Installation
+
+### For Users
+
+You can run **MicroPng** directly without installation using `npx`:
+
+```bash
+npx micropng-cli --help
+```
+
+Or install it globally to use the `micropng` command anywhere:
+
+```bash
+npm install -g micropng-cli
+```
+
+### For Developers
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for local development setup.
+
+## Usage
+
+### Basic Usage
+
+Compress a single file:
+
+```bash
+micropng-cli input.png --output compressed.png
+```
+
+Compress a directory of images:
+
+```bash
+micropng-cli ./images --output ./compressed-images
+```
+
+### Recursive Processing
+
+Process all images in a folder and its subfolders, maintaining the directory structure:
+
+```bash
+micropng-cli ./photos --recursive --output ./optimized-photos
+```
+
+### In-Place Replacement (Overwrite)
+
+⚠️ **Warning**: This will replace your original files!
+
+Compress and overwrite images in-place safely:
+
+```bash
+micropng-cli ./project-assets --recursive --replace
+```
+
+### Format Conversion
+
+Convert all PNGs to WebP:
+
+```bash
+micropng-cli ./images --format webp --output ./webp-images --recursive
+```
+
+### Options
+
+| Option | Alias | Description | Default |
+| :--- | :--- | :--- | :--- |
+| `--output <dir>` | `-o` | Output directory | (Current dir) |
+| `--recursive` | `-r` | Process subfolders deeply | `false` |
+| `--replace` | | Overwrite original files | `false` |
+| `--quality <number>` | `-q` | Compression quality (1-100) | `80` |
+| `--width <number>` | `-w` | Resize width in pixels | (Original) |
+| `--format <type>` | `-f` | Output format (jpeg, png, webp, avif) | (Original) |
+| `--concurrency <number>` | `-c` | Number of concurrent tasks | `5` |
+
+## Documentation
+
+-   [Contributing Guide](./CONTRIBUTING.md): Setup local dev environment and run tests.
+-   [Distribution Guide](./DISTRIBUTION.md): How to publish and release this package.
+
+## License
+
+ISC

package/dist/index.cjs

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+"use strict";var k=Object.create;var h=Object.defineProperty;var F=Object.getOwnPropertyDescriptor;var L=Object.getOwnPropertyNames;var z=Object.getPrototypeOf,R=Object.prototype.hasOwnProperty;var N=(r,e,t,i)=>{if(e&&typeof e=="object"||typeof e=="function")for(let s of L(e))!R.call(r,s)&&s!==t&&h(r,s,{get:()=>e[s],enumerable:!(i=F(e,s))||i.enumerable});return r};var c=(r,e,t)=>(t=r!=null?k(z(r)):{},N(e||!r||!r.__esModule?h(t,"default",{value:r,enumerable:!0}):t,r));var I=require("commander"),C=c(require("fast-glob"),1),q=c(require("p-limit"),1),a=c(require("path"),1),l=c(require("chalk"),1),E=c(require("fs-extra"),1);var x=c(require("sharp"),1),d=c(require("fs-extra"),1),$=c(require("path"),1);async function j(r,e,t){let{quality:i=80,width:s,format:f}=t,n=(0,x.default)(r);s&&(n=n.resize(s));let y=$.default.extname(r).toLowerCase(),m=f||y.slice(1);m==="jpeg"||m==="jpg"?n=n.jpeg({quality:i}):m==="png"?n=n.png({quality:i,compressionLevel:9}):m==="webp"?n=n.webp({quality:i}):m==="avif"&&(n=n.avif({quality:i}));let p=t.replace?`${r}.tmp_${Date.now()}`:e;try{await d.default.ensureDir($.default.dirname(p)),await n.toFile(p),t.replace&&await d.default.move(p,r,{overwrite:!0})}catch(o){throw t.replace&&await d.default.pathExists(p)&&await d.default.remove(p),o}}var O=new I.Command;O.name("micropng-cli").description("High-performance CLI image compressor").version("0.1.0").argument("<input>","Input file or directory").option("-o, --output <dir>","Output directory").option("-r, --recursive","Process subfolders deeply").option("--replace","OVERWRITE original files (Caution!)").option("-q, --quality <number>","Compression quality (1-100)","80").option("-w, --width <number>","Resize width in pixels").option("-f, --format <type>","Output format (jpeg, png, webp, avif)").option("-c, --concurrency <number>","Number of concurrent tasks","5").action(async(r,e)=>{try{let t=a.default.resolve(r),i=(await E.default.stat(t)).isDirectory(),s;if(i){let o=t.replace(/\\/g,"/");s=e.recursive?`${o}/**/*.{jpg,jpeg,png,webp}`:`${o}/*.{jpg,jpeg,png,webp}`}else s=t.replace(/\\/g,"/");let f=await(0,C.default)(s,{absolute:!0});if(f.length===0){console.log(l.default.yellow("No images found to process."));return}console.log(l.default.blue(`Found ${f.length} images. Processing...`));let n=(0,q.default)(parseInt(e.concurrency)),y=parseInt(e.quality),m=e.width?parseInt(e.width):void 0,p=f.map(o=>n(async()=>{try{let g;if(e.replace)g=o;else if(e.output){let u=i?a.default.relative(t,o):a.default.basename(o),b=a.default.dirname(u),w=a.default.extname(u),v=a.default.basename(u,w),D=e.format?`.${e.format}`:w;g=a.default.join(a.default.resolve(e.output),b,`${v}${D}`)}else{let u=a.default.extname(o),b=a.default.basename(o,u),w=a.default.dirname(o),v=e.format?`.${e.format}`:u;g=a.default.join(w,`${b}_compressed${v}`)}await j(o,g,{quality:y,width:m,format:e.format,replace:e.replace}),console.log(l.default.green(`\u2713 Processed: ${a.default.relative(process.cwd(),o)}`))}catch(g){console.error(l.default.red(`\u2717 Failed: ${o} - ${g.message}`))}}));await Promise.all(p),console.log(l.default.bold.cyan(`
+Compression complete!`))}catch(t){console.error(l.default.red.bold(`Error: ${t.message}`)),process.exit(1)}});O.parse(process.argv);

package/dist/index.d.cts

@@ -0,0 +1 @@
+#!/usr/bin/env node

package/dist/index.d.ts

@@ -0,0 +1 @@
+#!/usr/bin/env node

package/dist/index.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+import{Command as q}from"commander";import E from"fast-glob";import O from"p-limit";import o from"path";import g from"chalk";import D from"fs-extra";import C from"sharp";import d from"fs-extra";import v from"path";async function $(c,e,a){let{quality:n=80,width:m,format:u}=a,t=C(c);m&&(t=t.resize(m));let w=v.extname(c).toLowerCase(),s=u||w.slice(1);s==="jpeg"||s==="jpg"?t=t.jpeg({quality:n}):s==="png"?t=t.png({quality:n,compressionLevel:9}):s==="webp"?t=t.webp({quality:n}):s==="avif"&&(t=t.avif({quality:n}));let i=a.replace?`${c}.tmp_${Date.now()}`:e;try{await d.ensureDir(v.dirname(i)),await t.toFile(i),a.replace&&await d.move(i,c,{overwrite:!0})}catch(r){throw a.replace&&await d.pathExists(i)&&await d.remove(i),r}}var h=new q;h.name("micropng-cli").description("High-performance CLI image compressor").version("0.1.0").argument("<input>","Input file or directory").option("-o, --output <dir>","Output directory").option("-r, --recursive","Process subfolders deeply").option("--replace","OVERWRITE original files (Caution!)").option("-q, --quality <number>","Compression quality (1-100)","80").option("-w, --width <number>","Resize width in pixels").option("-f, --format <type>","Output format (jpeg, png, webp, avif)").option("-c, --concurrency <number>","Number of concurrent tasks","5").action(async(c,e)=>{try{let a=o.resolve(c),n=(await D.stat(a)).isDirectory(),m;if(n){let r=a.replace(/\\/g,"/");m=e.recursive?`${r}/**/*.{jpg,jpeg,png,webp}`:`${r}/*.{jpg,jpeg,png,webp}`}else m=a.replace(/\\/g,"/");let u=await E(m,{absolute:!0});if(u.length===0){console.log(g.yellow("No images found to process."));return}console.log(g.blue(`Found ${u.length} images. Processing...`));let t=O(parseInt(e.concurrency)),w=parseInt(e.quality),s=e.width?parseInt(e.width):void 0,i=u.map(r=>t(async()=>{try{let p;if(e.replace)p=r;else if(e.output){let l=n?o.relative(a,r):o.basename(r),y=o.dirname(l),f=o.extname(l),b=o.basename(l,f),x=e.format?`.${e.format}`:f;p=o.join(o.resolve(e.output),y,`${b}${x}`)}else{let l=o.extname(r),y=o.basename(r,l),f=o.dirname(r),b=e.format?`.${e.format}`:l;p=o.join(f,`${y}_compressed${b}`)}await $(r,p,{quality:w,width:s,format:e.format,replace:e.replace}),console.log(g.green(`\u2713 Processed: ${o.relative(process.cwd(),r)}`))}catch(p){console.error(g.red(`\u2717 Failed: ${r} - ${p.message}`))}}));await Promise.all(i),console.log(g.bold.cyan(`
+Compression complete!`))}catch(a){console.error(g.red.bold(`Error: ${a.message}`)),process.exit(1)}});h.parse(process.argv);

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "micropng-cli",
+  "version": "0.1.0",
+  "description": "High-performance CLI image compressor using sharp and libvips",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "main": "index.js",
+  "type": "module",
+  "bin": {
+    "micropng-cli": "./dist/index.js"
+  },
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "test": "vitest run",
+    "test:coverage": "vitest run --coverage",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "image-compression",
+    "cli",
+    "sharp",
+    "recursive",
+    "optimization"
+  ],
+  "author": "Sahil",
+  "license": "ISC",
+  "dependencies": {
+    "chalk": "^5.6.2",
+    "commander": "^14.0.2",
+    "fast-glob": "^3.3.3",
+    "fs-extra": "^11.3.3",
+    "p-limit": "^7.2.0",
+    "sharp": "^0.34.5"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.4",
+    "@types/node": "^25.1.0",
+    "@types/sharp": "^0.31.1",
+    "@vitest/coverage-v8": "^4.0.18",
+    "pkg": "^5.8.1",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.18"
+  }
+}