optimo 0.0.0 → 0.0.7

package/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright © 2026 Kiko Beats <josefrancisco.verdu@gmail.com> (kikobeats.com)
+Copyright © 2019 Microlink <hello@microlink.io> (microlink.io)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,43 +1,56 @@
-# optimo
-
-<p align="center">
-  <br>
-  <img src="https://i.imgur.com/Mh13XWB.gif" alt="optimo">
+<div align="center">
   <br>
-</p>
-
-![Last version](https://img.shields.io/github/tag/kikobeats/optimo.svg?style=flat-square)
-[![Coverage Status](https://img.shields.io/coveralls/kikobeats/optimo.svg?style=flat-square)](https://coveralls.io/github/kikobeats/optimo)
-[![NPM Status](https://img.shields.io/npm/dm/optimo.svg?style=flat-square)](https://www.npmjs.org/package/optimo)
-
-**NOTE:** more badges availables in [shields.io](https://shields.io/)
+  <img style="width: 500px; margin:3rem 0 1.5rem;" src="https://github.com/Kikobeats/optimo/raw/master/media/banner.jpg" alt="optimo">
+  <br><br>
+  <a href="https://microlink.io"><img src="https://img.shields.io/badge/powered_by-microlink.io-blue?style=flat-square&color=%23EA407B" alt="Powered by microlink.io"></a>
+  <img alt="Last version" src="https://img.shields.io/github/tag/kikobeats/optimo.svg?style=flat-square">
+  <a href="https://www.npmjs.org/package/optimo"><img alt="NPM Status" src="https://img.shields.io/npm/dm/optimo.svg?style=flat-square"></a>
+  <br><br>
+</div>
 
-> The no-brainer ImageMagick CLI for optimizing images
+`optimo` is an CLI for aggressively reducing image file size with sane defaults. It's implemented on top of [ImageMagick](https://imagemagick.org/#gsc.tab=0).
 
 ## Install
 
 ```bash
-$ npm install optimo --global
+npx -y optimo public/media            # for a directory
+npx -y optimo public/media/banner.png # for a file
+npx -y optimo public/media/banner.png -f jpeg # convert + optimize
 ```
 
-## CLI
+## Optimization Strategy
 
-```bash
-$ optimo --help
+- Compression-first per format.
+- Metadata stripping (`-strip`) where applicable.
+- Format-specific tuning for stronger size reduction.
+- Safety guard: if optimized output is not smaller, original file is kept.
+
+## Programmatic API
+
+```js
+const optimo = require('optimo')
 
-  Generates regular expressions that match a set of strings.
+// optimize a single file
+await optimo.file('/absolute/path/image.jpg', {
+  dryRun: false,
+  format: 'webp',
+  onLogs: console.log
+})
 
-  Usage
-    $ optimo [-gimuy] string1 string2 string3...
+// optimize a dir recursively
+const result = await optimo.dir('/absolute/path/images')
 
-  Examples
-    $ optimo foobar foobaz foozap fooza
-    $ jq '.keywords' package.json | optimo
+console.log(result)
+// {
+//   originalSize: Number,
+//   optimizedSize: Number,
+//   savings: Number
+// }
 ```
 
 ## License
 
-**optimo** © [Kiko Beats](https://kikobeats.com), released under the [MIT](https://github.com/kikobeats/optimo/blob/master/LICENSE.md) License.<br>
-Authored and maintained by [Kiko Beats](https://kikobeats.com) with help from [contributors](https://github.com/kikobeats/optimo/contributors).
+**optimo** © [Microlink](https://microlink.io), released under the [MIT](https://github.com/microlinkhq/optimo/blob/master/LICENSE.md) License.<br>
+Authored and maintained by [Kiko Beats](https://kikobeats.com) with help from [contributors](https://github.com/microlinkhq/optimo/contributors).
 
-> [kikobeats.com](https://kikobeats.com) · GitHub [Kiko Beats](https://github.com/kikobeats) · Twitter [@kikobeats](https://twitter.com/kikobeats)
+> [microlink.io](https://microlink.io) · GitHub [microlinkhq](https://github.com/microlinkhq) · X [@microlinkhq](https://x.com/microlinkhq)

package/bin/help.js

@@ -0,0 +1,19 @@
+'use strict'
+
+const { gray, blue } = require('../src/colors')
+
+module.exports = gray(`Efortless image optimizer
+
+Usage
+  $ ${blue('optimo')} <file|dir> [options]
+
+Options
+  -d, --dry-run  Show what would be optimized without making changes
+  -f, --format   Convert output format (e.g. jpeg, webp, avif)
+
+Examples
+  $ optimo image.jpg
+  $ optimo image.png --dry-run
+  $ optimo image.jpg -d
+  $ optimo image.png -f jpeg
+`)

package/bin/index.js

@@ -1,49 +1,46 @@
 #!/usr/bin/env node
 'use strict'
 
-const path = require('path')
-const pkg = require('../package.json')
-const JoyCon = require('joycon')
+const { stat } = require('node:fs/promises')
+const optimo = require('optimo')
 const mri = require('mri')
 
-require('update-notifier')({ pkg }).notify()
+const colors = require('../src/colors')
 
-const { _, ...flags } = mri(process.argv.slice(2), {
-  /* https://github.com/lukeed/mri#usage< */
-  default: {
-    token: process.env.GH_TOKEN || process.env.GITHUB_TOKEN
+async function main () {
+  const argv = mri(process.argv.slice(2), {
+    alias: {
+      'dry-run': 'd',
+      format: 'f',
+      silent: 's'
+    }
+  })
+
+  const input = argv._[0]
+
+  if (!input) {
+    console.log(require('./help'))
+    process.exit(0)
   }
-})
 
-if (flags.help) {
-  console.log(require('fs').readFileSync('./help.txt', 'utf8'))
+  const stats = await stat(input)
+  const isDirectory = stats.isDirectory()
+  const fn = isDirectory ? optimo.dir : optimo.file
+
+  const logger = argv.silent ? () => {} : logEntry => console.log(logEntry)
+  !argv.silent && console.log()
+
+  await fn(input, {
+    dryRun: argv['dry-run'],
+    format: argv.format,
+    onLogs: logger
+  })
+
   process.exit(0)
 }
 
-const joycon = new JoyCon({
-  cwd,
-  packageKey: pkg.name,
-  files: [
-    'package.json',
-    `.${pkg.name}rc`,
-    `.${pkg.name}rc.json`,
-    `.${pkg.name}rc.js`,
-    `${pkg.name}.config.js`
-  ]
+main().catch(error => {
+  console.error(`${colors.red('Error:')} ${error.message}`)
+  console.error(error.stack)
+  process.exit(1)
 })
-
-const { data: config = {} } = (await joycon.load()) || {}
-
-Promise.resolve(
-  require('optimo')({
-    ...config,
-    ...flags
-  })
-)
-  .then(() => {
-    process.exit(0)
-  })
-  .catch(error => {
-    console.error(error)
-    process.exit(1)
-  })

package/package.json

@@ -2,7 +2,10 @@
   "name": "optimo",
   "description": "The no-brainer ImageMagick CLI for optimizing images",
   "homepage": "https://github.com/kikobeats/optimo",
-  "version": "0.0.0",
+  "version": "0.0.7",
+  "exports": {
+    ".": "./src/index.js"
+  },
   "bin": {
     "optimo": "bin/index.js"
   },
@@ -11,6 +14,7 @@
     "name": "Kiko Beats",
     "url": "https://kikobeats.com"
   },
+  "contributors": [],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/kikobeats/optimo.git"
@@ -28,7 +32,8 @@
     "optimize"
   ],
   "dependencies": {
-    "mri": "~1.2.0"
+    "mri": "~1.2.0",
+    "tinyspawn": "~1.5.5"
   },
   "devDependencies": {
     "@commitlint/cli": "latest",
@@ -36,18 +41,22 @@
     "@ksmithut/prettier-standard": "latest",
     "ava": "latest",
     "c8": "latest",
+    "conventional-changelog-cli": "latest",
     "finepack": "latest",
     "git-authors-cli": "latest",
     "github-generate-release": "latest",
     "nano-staged": "latest",
     "simple-git-hooks": "latest",
     "standard": "latest",
-    "standard-markdown": "latest",
     "standard-version": "latest"
   },
   "engines": {
     "node": ">= 24"
   },
+  "files": [
+    "bin",
+    "src"
+  ],
   "preferGlobal": true,
   "license": "MIT",
   "commitlint": {
@@ -60,17 +69,11 @@
       ]
     }
   },
-  "exports": {
-    ".": "./cli/index.js"
-  },
   "nano-staged": {
     "*.js": [
       "prettier-standard",
       "standard --fix"
     ],
-    "*.md": [
-      "standard-markdown"
-    ],
     "package.json": [
       "finepack"
     ]
@@ -81,14 +84,18 @@
   },
   "scripts": {
     "clean": "rm -rf node_modules",
-    "contributors": "(npx git-authors-cli && npx finepack && git add package.json && git commit -m 'build: contributors' --no-verify) || true",
+    "contributors": "(git-authors-cli && finepack && git add package.json && git commit -m 'build: contributors' --no-verify) || true",
     "coverage": "c8 report --reporter=text-lcov > coverage/lcov.info",
     "lint": "standard-markdown README.md && standard",
-    "postrelease": "pnpm release:tags && pnpm release:github && pnpm publish",
+    "postrelease": "pnpm release:tags && pnpm release:github && pnpm publish --access=public",
     "pretest": "pnpm lint",
-    "release": "standard-version -a",
+    "release": "pnpm release:version && pnpm release:changelog && pnpm release:commit && pnpm release:tag",
+    "release:changelog": "conventional-changelog -p conventionalcommits -i CHANGELOG.md -s",
+    "release:commit": "git add package.json CHANGELOG.md && git commit -m \"chore(release): $(node -p \"require('./package.json').version\")\"",
     "release:github": "github-generate-release",
-    "release:tags": "git push --follow-tags origin HEAD:master",
+    "release:tag": "git tag -a v$(node -p \"require('./package.json').version\") -m \"v$(node -p \"require('./package.json').version\")\"",
+    "release:tags": "git push origin HEAD:master --follow-tags",
+    "release:version": "standard-version --skip.changelog --skip.commit --skip.tag",
     "test": "c8 ava"
   }
 }

package/src/colors.js

@@ -0,0 +1,20 @@
+'use strict'
+
+const { styleText } = require('node:util')
+
+const gray = str => styleText('gray', str)
+
+const white = str => styleText('white', str)
+
+const green = str => styleText('green', str)
+
+const red = str => styleText('red', str)
+
+const yellow = str => styleText('yellow', str)
+
+const blue = str => styleText('blue', str)
+
+const label = (text, color) =>
+  styleText(['inverse', 'bold', color], ` ${text.toUpperCase()} `)
+
+module.exports = { gray, white, green, red, yellow, label, blue }

package/src/index.js

@@ -0,0 +1,247 @@
+'use strict'
+
+const { stat, unlink, rename, readdir } = require('node:fs/promises')
+const { execSync } = require('child_process')
+const path = require('node:path')
+const $ = require('tinyspawn')
+
+const { formatLog, formatBytes } = require('./util')
+const { yellow, gray, green } = require('./colors')
+
+/*
+ * JPEG preset (compression-first):
+ * - Favor smaller output via chroma subsampling and optimized Huffman coding.
+ * - Progressive scan improves perceived loading on the web.
+ */
+const MAGICK_JPEG_FLAGS = [
+  '-strip',
+  '-sampling-factor',
+  '4:2:0',
+  '-define',
+  'jpeg:optimize-coding=true',
+  '-define',
+  'jpeg:dct-method=float',
+  '-quality',
+  '80',
+  '-interlace',
+  'Plane'
+]
+
+/*
+ * PNG preset (maximum deflate effort):
+ * - Strip metadata payloads.
+ * - Use highest compression level with explicit strategy/filter tuning.
+ */
+const MAGICK_PNG_FLAGS = [
+  '-strip',
+  '-define',
+  'png:compression-level=9',
+  '-define',
+  'png:compression-strategy=1',
+  '-define',
+  'png:compression-filter=5'
+]
+
+/*
+ * GIF preset (animation optimization):
+ * - Coalesce frames before layer optimization to maximize delta compression.
+ * - OptimizePlus is more aggressive for animated GIF size reduction.
+ */
+const MAGICK_GIF_FLAGS = ['-strip', '-coalesce', '-layers', 'OptimizePlus']
+
+/*
+ * WebP preset (compression-first):
+ * - Use a strong encoder method and preserve compatibility with lossy output.
+ */
+const MAGICK_WEBP_FLAGS = [
+  '-strip',
+  '-define',
+  'webp:method=6',
+  '-define',
+  'webp:thread-level=1',
+  '-quality',
+  '80'
+]
+
+/*
+ * AVIF preset (compression-first):
+ * - Slow encoder speed for stronger compression.
+ */
+const MAGICK_AVIF_FLAGS = [
+  '-strip',
+  '-define',
+  'heic:speed=1',
+  '-quality',
+  '50'
+]
+
+/*
+ * HEIC/HEIF preset (compression-first):
+ * - Slow encoder speed for stronger compression.
+ */
+const MAGICK_HEIC_FLAGS = [
+  '-strip',
+  '-define',
+  'heic:speed=1',
+  '-quality',
+  '75'
+]
+
+/*
+ * JPEG XL preset (compression-first):
+ * - Use max effort where supported.
+ */
+const MAGICK_JXL_FLAGS = ['-strip', '-define', 'jxl:effort=9', '-quality', '75']
+
+/*
+ * SVG preset:
+ * - Keep optimization minimal to avoid destructive transformations.
+ */
+const MAGICK_SVG_FLAGS = ['-strip']
+
+/*
+ * Generic preset for any other format:
+ * - Keep it broadly safe across decoders while still reducing size.
+ */
+const MAGICK_GENERIC_FLAGS = ['-strip']
+
+const magickPath = (() => {
+  try {
+    return execSync('which magick', {
+      stdio: ['pipe', 'pipe', 'ignore']
+    })
+      .toString()
+      .trim()
+  } catch {
+    return false
+  }
+})()
+
+const percentage = (partial, total) =>
+  (((partial - total) / total) * 100).toFixed(1)
+
+const normalizeFormat = format => {
+  if (!format) return null
+
+  const normalized = String(format).trim().toLowerCase().replace(/^\./, '')
+  if (normalized === 'jpg') return 'jpeg'
+  if (normalized === 'tif') return 'tiff'
+
+  return normalized
+}
+
+const getOutputPath = (filePath, format) => {
+  const normalizedFormat = normalizeFormat(format)
+  if (!normalizedFormat) return filePath
+
+  const parsed = path.parse(filePath)
+  return path.join(parsed.dir, `${parsed.name}.${normalizedFormat}`)
+}
+
+const getMagickFlags = filePath => {
+  const ext = path.extname(filePath).toLowerCase()
+  if (ext === '.jpg' || ext === '.jpeg') return MAGICK_JPEG_FLAGS
+  if (ext === '.png') return MAGICK_PNG_FLAGS
+  if (ext === '.gif') return MAGICK_GIF_FLAGS
+  if (ext === '.webp') return MAGICK_WEBP_FLAGS
+  if (ext === '.avif') return MAGICK_AVIF_FLAGS
+  if (ext === '.heic' || ext === '.heif') return MAGICK_HEIC_FLAGS
+  if (ext === '.jxl') return MAGICK_JXL_FLAGS
+  if (ext === '.svg') return MAGICK_SVG_FLAGS
+  return MAGICK_GENERIC_FLAGS
+}
+
+const file = async (
+  filePath,
+  { onLogs = () => {}, dryRun, format: outputFormat } = {}
+) => {
+  if (!magickPath) {
+    throw new Error('ImageMagick is not installed')
+  }
+  const outputPath = getOutputPath(filePath, outputFormat)
+  const flags = getMagickFlags(outputPath)
+
+  const optimizedPath = `${outputPath}.optimized`
+  const isConverting = outputPath !== filePath
+
+  let originalSize
+  try {
+    ;[originalSize] = await Promise.all([
+      (await stat(filePath)).size,
+      await $('magick', [filePath, ...flags, optimizedPath])
+    ])
+  } catch {
+    onLogs(formatLog('[unsupported]', yellow, filePath))
+    return { originalSize: 0, optimizedSize: 0 }
+  }
+
+  const optimizedSize = (await stat(optimizedPath)).size
+
+  if (!isConverting && optimizedSize >= originalSize) {
+    await unlink(optimizedPath)
+    onLogs(formatLog('[optimized]', gray, filePath))
+    return { originalSize, optimizedSize: originalSize }
+  }
+
+  if (dryRun) {
+    await unlink(optimizedPath)
+  } else {
+    if (isConverting) {
+      try {
+        await unlink(outputPath)
+      } catch (error) {
+        if (error.code !== 'ENOENT') throw error
+      }
+    } else {
+      await unlink(filePath)
+    }
+
+    await rename(optimizedPath, outputPath)
+
+    if (isConverting) {
+      await unlink(filePath)
+    }
+  }
+
+  onLogs(
+    formatLog(
+      `[${percentage(optimizedSize, originalSize)}%]`,
+      green,
+      isConverting ? `${filePath} -> ${outputPath}` : filePath
+    )
+  )
+
+  return { originalSize, optimizedSize }
+}
+
+const dir = async (folderPath, opts) => {
+  const items = (await readdir(folderPath, { withFileTypes: true })).filter(
+    item => !item.name.startsWith('.')
+  )
+  let totalOriginalSize = 0
+  let totalOptimizedSize = 0
+
+  for (const item of items) {
+    const itemPath = path.join(folderPath, item.name)
+
+    if (item.isDirectory()) {
+      const subResult = await dir(itemPath, opts)
+      totalOriginalSize += subResult.originalSize
+      totalOptimizedSize += subResult.optimizedSize
+    } else {
+      const result = await file(itemPath, opts)
+      totalOriginalSize += result.originalSize
+      totalOptimizedSize += result.optimizedSize
+    }
+  }
+
+  return {
+    originalSize: totalOriginalSize,
+    optimizedSize: totalOptimizedSize,
+    savings: totalOriginalSize - totalOptimizedSize
+  }
+}
+
+module.exports.file = file
+module.exports.dir = dir
+module.exports.formatBytes = formatBytes

package/src/util.js

@@ -0,0 +1,24 @@
+'use strict'
+
+const { gray } = require('./colors')
+
+const MAX_STATUS_LENGTH = 13 // Length of '[unsupported]'
+
+const formatBytes = bytes => {
+  if (bytes === 0) return '0 B'
+  const k = 1024
+  const sizes = ['B', 'KB', 'MB', 'GB']
+  const i = Math.floor(Math.log(bytes) / Math.log(k))
+  return parseFloat((bytes / Math.pow(k, i)).toFixed(1)) + ' ' + sizes[i]
+}
+
+const formatLog = (plainStatus, colorize, filePath) => {
+  const padding = MAX_STATUS_LENGTH - plainStatus.length
+  const paddedPlainStatus = plainStatus + ' '.repeat(Math.max(0, padding))
+  return `${colorize(paddedPlainStatus)} ${gray(filePath)}`
+}
+
+module.exports = {
+  formatBytes,
+  formatLog
+}

package/.editorconfig

@@ -1,19 +0,0 @@
-# https://editorconfig.org
-
-root = true
-
-[*]
-indent_style = space
-indent_size = 2
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-max_line_length = 80
-indent_brace_style = 1TBS
-spaces_around_operators = true
-quote_type = auto
-
-[package.json]
-indent_style = space
-indent_size = 2

package/.gitattributes

@@ -1 +0,0 @@
-* text=auto

package/.github/dependabot.yml

@@ -1,11 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: npm
-    directory: '/'
-    schedule:
-      interval: daily
-  - package-ecosystem: 'github-actions'
-    directory: '/'
-    schedule:
-      # Check for updates to GitHub Actions every weekday
-      interval: 'daily'

package/bin/help.txt

@@ -1,13 +0,0 @@
-Usage
-  $ optimo <command>[options]
-
-Commands
-  --file Read the file
-
-Options
-  --wait  Wait for the app to exit
-
-Examples
-  $ npm-url # Open the current package if you are over package.json path.
-  $ npm-url json-future
-  $ npm-url json-future -- 'google chrome' --incognito

package/index.js

@@ -1,3 +0,0 @@
-'use strict'
-
-module.exports = () => {}