image-convert-cli 1.1.5 → 1.2.0

package/CHANGELOG.md

@@ -0,0 +1,68 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [1.2.0] - 2026-02-13
+
+### Added
+- SVG support as input format with automatic resize handling
+- Tilde (~) expansion for home directory in file paths
+- CHANGELOG for version tracking
+- Test coverage script (`bun run test:coverage`)
+
+### Tests
+- Unit tests for SVG conversion
+- Unit tests for path completion with tilde expansion
+
+## [1.1.6] - 2026-02-13
+
+### Added
+- MIT license (LICENSE.md)
+- IDE config files to .gitignore
+
+## [1.1.5] - 2025-02-10
+
+### Changed
+- Bump version to 1.1.5
+- Improve documentation
+
+## [1.1.4] - 2025-02-08
+
+### Changed
+- Bump version to 1.1.4
+
+## [1.1.3] - 2025-02-08
+
+### Fixed
+- Use dynamic version from package.json
+
+## [1.1.2] - 2025-02-08
+
+### Added
+- Auto-update flag and confirmation prompt for self-update
+- Batch conversion mode for directories
+
+## [1.1.1] - 2025-02-07
+
+### Added
+- Version command to display CLI version
+
+### Changed
+- Exclude assets from npm package
+
+## [1.1.0] - 2025-02-07
+
+### Added
+- Self-update check command
+
+### Changed
+- Demo video and reorganize assets folder
+
+## [1.0.0] - 2025-02-07
+
+### Added
+- PNG format support for image conversion
+- Prepare project for npm/bun publishing
+
+### Changed
+- Enhance README with installation, usage examples, and development guide

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 lukenguyen-me
+
+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/dist/index.js

@@ -6577,6 +6577,7 @@ import { spawn } from "child_process";
 // src/prompts.ts
 import * as readline3 from "readline";
 import * as fs3 from "fs";
+import * as os from "os";
 import * as path2 from "path";
 
 // node_modules/@inquirer/core/dist/lib/key.js
@@ -6723,7 +6724,7 @@ var effectScheduler = {
 // node_modules/@inquirer/core/dist/lib/use-state.js
 function useState(defaultValue) {
   return withPointer((pointer) => {
-    const setState = AsyncResource2.bind(function setState(newValue) {
+    const setState = AsyncResource2.bind(function setState2(newValue) {
       if (pointer.get() !== newValue) {
         pointer.set(newValue);
         handleChange();
@@ -8322,11 +8323,11 @@ function isSameFormat(sourcePath, targetFormat) {
   }
   return false;
 }
-var SUPPORTED_FORMATS = ["webp", "jpeg", "jpg", "png"];
+var INPUT_FORMATS = ["webp", "jpeg", "jpg", "png", "svg"];
 function getImageFilesFromDirectory(dirPath) {
   try {
     const entries = fs.readdirSync(dirPath, { withFileTypes: true });
-    return entries.filter((entry) => entry.isFile()).map((entry) => path.join(dirPath, entry.name)).filter((filePath) => SUPPORTED_FORMATS.includes(getExtension(filePath)));
+    return entries.filter((entry) => entry.isFile()).map((entry) => path.join(dirPath, entry.name)).filter((filePath) => INPUT_FORMATS.includes(getExtension(filePath)));
   } catch {
     return [];
   }
@@ -8361,7 +8362,11 @@ async function convertImage(sourcePath, destinationPath, format, compress) {
       default:
         throw new Error(`Unsupported format: ${format}`);
     }
-    await import_sharp.default(sourcePath).toFormat(sharpFormat, options).toFile(destinationPath);
+    let sharpInstance = import_sharp.default(sourcePath);
+    if (getExtension(sourcePath) === "svg") {
+      sharpInstance = sharpInstance.resize(512, 512, { fit: "inside" });
+    }
+    await sharpInstance.toFormat(sharpFormat, options).toFile(destinationPath);
     const outputSize = fs2.statSync(destinationPath).size;
     const elapsed = Date.now() - startTime;
     return {
@@ -8474,7 +8479,11 @@ function filePathCompleter(line) {
   const trimmed = line.trim();
   const input = trimmed.split(" ")[0] || ".";
   const isDirectoryInput = input.endsWith("/");
-  const dir = isDirectoryInput ? input.slice(0, -1) || "." : path2.dirname(input) || ".";
+  let dir = isDirectoryInput ? input.slice(0, -1) || "." : path2.dirname(input) || ".";
+  if (dir === "~" || dir.startsWith("~/")) {
+    const homeDir = os.homedir();
+    dir = dir === "~" ? homeDir : homeDir + dir.slice(1);
+  }
   const base = isDirectoryInput ? "" : path2.basename(input) || "";
   try {
     const files = fs3.readdirSync(dir, { withFileTypes: true });
@@ -8599,6 +8608,7 @@ Options:
   --yes, -y        Non-interactive mode (use defaults for optional prompts)
   --source, -s     Source file path (required with -y)
   --format, -f     Target format: webp, jpeg, jpg, or png (required with -y)
+                   Input formats: webp, jpeg, jpg, png, svg
   --dest, -d       Destination path (optional, auto-generated if not provided)
   --compress, -c   Enable compression (optional, default: false)
 
@@ -8638,7 +8648,8 @@ Conversion settings:`);
 // package.json
 var package_default = {
   name: "image-convert-cli",
-  version: "1.1.5",
+  version: "1.2.0",
+  license: "MIT",
   type: "module",
   bin: {
     imgc: "./dist/index.js"
@@ -8646,6 +8657,7 @@ var package_default = {
   scripts: {
     start: "bun bin/index.ts",
     test: "bun test",
+    "test:coverage": "bun test --coverage",
     prepare: "husky install",
     build: "bun build ./bin/index.ts --outdir ./dist --target bun",
     publish: "bun run build && bun publish --access public --ignore-scripts"
@@ -8658,7 +8670,7 @@ var package_default = {
     sharp: "^0.34.5"
   },
   devDependencies: {
-    "@types/bun": "^1.3.8",
+    "@types/bun": "^1.3.9",
     husky: "^9.1.7"
   },
   repository: {
@@ -8751,7 +8763,7 @@ async function runCli(options, promptService) {
     prompts.showHelp();
     return;
   }
-  console.log(`Image Converter - Convert images to webp, jpeg, or jpg
+  console.log(`Image Converter - Convert images between webp, jpeg, jpg, png, and svg
 `);
   const sourcePath = options.source || await prompts.promptSourceFile();
   const targetFormat = options.format || await prompts.promptFormat();

package/package.json

@@ -1,6 +1,7 @@
 {
   "name": "image-convert-cli",
-  "version": "1.1.5",
+  "version": "1.2.0",
+  "license": "MIT",
   "type": "module",
   "bin": {
     "imgc": "./dist/index.js"
@@ -8,6 +9,7 @@
   "scripts": {
     "start": "bun bin/index.ts",
     "test": "bun test",
+    "test:coverage": "bun test --coverage",
     "prepare": "husky install",
     "build": "bun build ./bin/index.ts --outdir ./dist --target bun",
     "publish": "bun run build && bun publish --access public --ignore-scripts"
@@ -20,7 +22,7 @@
     "sharp": "^0.34.5"
   },
   "devDependencies": {
-    "@types/bun": "^1.3.8",
+    "@types/bun": "^1.3.9",
     "husky": "^9.1.7"
   },
   "repository": {

package/src/cli.ts

@@ -118,7 +118,7 @@ export async function runCli(
     return;
   }
 
-  console.log("Image Converter - Convert images to webp, jpeg, or jpg\n");
+  console.log("Image Converter - Convert images between webp, jpeg, jpg, png, and svg\n");
 
   const sourcePath = options.source || await prompts.promptSourceFile();
 

package/src/converter.ts

@@ -12,6 +12,7 @@ import {
   getImageFilesFromDirectory,
   isSameFormat,
   ensureDirectoryExists,
+  getExtension,
 } from "./utils/path";
 
 export async function convertImage(
@@ -52,7 +53,14 @@ export async function convertImage(
     }
 
     // Perform the conversion
-    await sharp(sourcePath)
+    let sharpInstance = sharp(sourcePath);
+
+    // For SVG input, resize to get proper output dimensions
+    if (getExtension(sourcePath) === "svg") {
+      sharpInstance = sharpInstance.resize(512, 512, { fit: "inside" });
+    }
+
+    await sharpInstance
       .toFormat(sharpFormat, options)
       .toFile(destinationPath);
 

package/src/prompts.ts

@@ -1,18 +1,27 @@
 import * as readline from "node:readline";
 import * as fs from "node:fs";
+import * as os from "node:os";
 import * as path from "node:path";
 import { select, confirm } from "@inquirer/prompts";
 import type { SupportedFormat, ConversionSettings } from "./types";
-import { getDefaultDestinationPath } from "./utils/path";
 import { displayConversionResult } from "./converter";
 
-function filePathCompleter(line: string): readline.CompleterResult {
+export function filePathCompleter(line: string): readline.CompleterResult {
   const trimmed = line.trim();
   const input = trimmed.split(" ")[0] || ".";
 
   const isDirectoryInput = input.endsWith("/");
-  const dir = isDirectoryInput ? input.slice(0, -1) || "." : path.dirname(input) || ".";
-  const base = isDirectoryInput ? "" : (path.basename(input) || "");
+  let dir = isDirectoryInput
+    ? input.slice(0, -1) || "."
+    : path.dirname(input) || ".";
+
+  // Expand tilde to home directory
+  if (dir === "~" || dir.startsWith("~/")) {
+    const homeDir = os.homedir();
+    dir = dir === "~" ? homeDir : homeDir + dir.slice(1);
+  }
+
+  const base = isDirectoryInput ? "" : path.basename(input) || "";
 
   try {
     const files: fs.Dirent[] = fs.readdirSync(dir, { withFileTypes: true });
@@ -56,7 +65,9 @@ async function inputWithPathCompletion(
         const validationResult = validate(result);
         if (validationResult !== true) {
           console.log(`\nError: ${validationResult}`);
-          inputWithPathCompletion(message, defaultValue, validate).then(resolve);
+          inputWithPathCompletion(message, defaultValue, validate).then(
+            resolve,
+          );
           return;
         }
       }
@@ -68,16 +79,29 @@ async function inputWithPathCompletion(
 
 export interface IPromptService {
   promptSourceFile(validate?: (path: string) => string | true): Promise<string>;
-  promptDestination(defaultPath: string, validate?: (path: string) => string | true): Promise<string>;
+  promptDestination(
+    defaultPath: string,
+    validate?: (path: string) => string | true,
+  ): Promise<string>;
   promptFormat(): Promise<SupportedFormat>;
   promptCompress(): Promise<boolean>;
   promptConfirm(settings: ConversionSettings): Promise<boolean>;
   promptForOverwrite(filePath: string): Promise<boolean>;
-  promptBatchDestination(defaultPath: string, validate?: (path: string) => string | true): Promise<string>;
+  promptBatchDestination(
+    defaultPath: string,
+    validate?: (path: string) => string | true,
+  ): Promise<string>;
   promptBatchConfirm(fileCount: number): Promise<boolean>;
   showHelp(): void;
   showSettings(settings: ConversionSettings): void;
-  showResult(result: { success: boolean; destinationPath: string; elapsed: number; originalSize: number; outputSize: number; error?: string }): void;
+  showResult(result: {
+    success: boolean;
+    destinationPath: string;
+    elapsed: number;
+    originalSize: number;
+    outputSize: number;
+    error?: string;
+  }): void;
 }
 
 export class InteractivePromptService implements IPromptService {
@@ -197,6 +221,7 @@ Options:
   --yes, -y        Non-interactive mode (use defaults for optional prompts)
   --source, -s     Source file path (required with -y)
   --format, -f     Target format: webp, jpeg, jpg, or png (required with -y)
+                   Input formats: webp, jpeg, jpg, png, svg
   --dest, -d       Destination path (optional, auto-generated if not provided)
   --compress, -c   Enable compression (optional, default: false)
 
@@ -222,7 +247,14 @@ Examples:
     console.log(`  Compression: ${settings.compress ? "Yes" : "No"}`);
   }
 
-  showResult(result: { success: boolean; destinationPath: string; elapsed: number; originalSize: number; outputSize: number; error?: string }): void {
+  showResult(result: {
+    success: boolean;
+    destinationPath: string;
+    elapsed: number;
+    originalSize: number;
+    outputSize: number;
+    error?: string;
+  }): void {
     displayConversionResult({
       success: result.success,
       sourcePath: "",

package/src/utils/path.ts

@@ -33,7 +33,7 @@ export function isSameFormat(sourcePath: string, targetFormat: SupportedFormat):
   return false;
 }
 
-const SUPPORTED_FORMATS = ["webp", "jpeg", "jpg", "png"];
+export const INPUT_FORMATS = ["webp", "jpeg", "jpg", "png", "svg"];
 
 export function getImageFilesFromDirectory(dirPath: string): string[] {
   try {
@@ -41,7 +41,7 @@ export function getImageFilesFromDirectory(dirPath: string): string[] {
     return entries
       .filter((entry) => entry.isFile())
       .map((entry) => path.join(dirPath, entry.name))
-      .filter((filePath) => SUPPORTED_FORMATS.includes(getExtension(filePath)));
+      .filter((filePath) => INPUT_FORMATS.includes(getExtension(filePath)));
   } catch {
     return [];
   }