@node-minify/utils

Shared utilities for node-minify compressor packages.

This package provides common file operations, argument building, and helper functions used internally by node-minify compressors.

Installation

npm install @node-minify/utils

Exported Functions

File Operations

| Function | Description | |----------|-------------| | readFile(filePath) | Read file contents as a string | | writeFile({ file, content, index }) | Write content to a file | | deleteFile(file) | Delete a file from the filesystem | | isValidFile(filePath) | Check if a file exists and is readable | | getContentFromFiles(settings) | Read and concatenate content from multiple files |

File Size Utilities

| Function | Description | |----------|-------------| | getFilesizeInBytes(filePath) | Get human-readable file size (e.g., "1.5 kB") | | getFilesizeGzippedInBytes(content) | Get human-readable gzipped size | | prettyBytes(bytes) | Format bytes as human-readable string |

Compression Helpers

| Function | Description | |----------|-------------| | compressSingleFile(settings) | Compress a single file using the configured compressor | | run(settings) | Execute compression with the provided settings | | buildArgs(options) | Build command line arguments from options object | | toBuildArgsOptions(options, definitions) | Convert options to buildArgs format | | setFileNameMin(file, output, publicFolder, replaceInPlace) | Generate output filename from input |

Deprecation Warnings

| Function | Description | |----------|-------------| | warnDeprecation(packageName, message) | Display a deprecation warning (once per package) | | resetDeprecationWarnings() | Reset warning state (useful for testing) |

Usage Example

import { readFile, writeFile, getFilesizeInBytes } from '@node-minify/utils';

// Read a file
const content = await readFile('src/app.js');

// Write minified content
await writeFile({
  file: 'dist/app.min.js',
  content: minifiedContent,
  index: 0
});

// Get file size
const size = await getFilesizeInBytes('dist/app.min.js');
console.log(`Output size: ${size}`); // "Output size: 2.3 kB"

License

MIT