smartformat/readme.md

# @push.rocks/smartformat

Format machine values into strings humans can scan instantly. `@push.rocks/smartformat` is a small ESM TypeScript package that exports the proven `pretty-bytes` and `pretty-ms` formatters from one Push Rocks namespace.

Use it when logs, dashboards, CLIs, progress views, test output, or API responses need readable file sizes and durations without custom formatting code.

## Issue Reporting and Security

For reporting bugs, issues, or security vulnerabilities, please visit [community.foss.global/](https://community.foss.global/). This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a [code.foss.global/](https://code.foss.global/) account to submit Pull Requests directly.

## Installation

```bash
pnpm add @push.rocks/smartformat
```

## What You Get

- `prettyBytes(number, options?)` converts bytes or bits into SI or binary-prefixed strings.
- `prettyMs(milliseconds, options?)` converts durations into compact, verbose, colon-style, or precision-focused strings.
- Native ESM and TypeScript declarations via the published `dist_ts` build.
- Browser and Node.js compatibility through the package's web build pipeline.

## Quick Start

```typescript
import { prettyBytes, prettyMs } from '@push.rocks/smartformat';

const downloaded = prettyBytes(1337);
// '1.34 kB'

const duration = prettyMs(1337);
// '1.3s'

console.log(`Downloaded ${downloaded} in ${duration}`);
// Downloaded 1.34 kB in 1.3s
```

You can also import the namespace when that reads better in your codebase:

```typescript
import * as smartformat from '@push.rocks/smartformat';

smartformat.prettyBytes(42, { signed: true });
// '+42 B'

smartformat.prettyMs(95_500, { colonNotation: true });
// '1:35.5'
```

## Formatting Bytes

`prettyBytes` is ideal for file sizes, payload sizes, storage usage, upload/download progress, and byte deltas.

```typescript
import { prettyBytes } from '@push.rocks/smartformat';

prettyBytes(100);
// '100 B'

prettyBytes(1_337);
// '1.34 kB'

prettyBytes(1_024, { binary: true });
// '1 KiB'

prettyBytes(1_337, { bits: true });
// '1.34 kbit'

prettyBytes(42, { signed: true });
// '+42 B'

prettyBytes(1_337, { locale: 'de' });
// '1,34 kB'
```

Useful `prettyBytes` options include:

- `bits`: format values as bits instead of bytes.
- `binary`: use binary prefixes like `KiB` instead of SI prefixes like `kB`.
- `signed`: include a plus sign for positive values, useful for diffs.
- `locale`: localize number formatting while keeping the unit label stable.
- `minimumFractionDigits` and `maximumFractionDigits`: control decimal precision.
- `space` and `nonBreakingSpace`: control spacing between value and unit.
- `fixedWidth`: right-align output for tables, progress bars, and terminal output.

## Formatting Durations

`prettyMs` is built for elapsed time, latency, countdowns, retries, benchmark output, and job runtimes.

```typescript
import { prettyMs } from '@push.rocks/smartformat';

prettyMs(133);
// '133ms'

prettyMs(1_337);
// '1.3s'

prettyMs(1_337_000_000);
// '15d 11h 23m 20s'

prettyMs(1_335_669_000, { verbose: true });
// '15 days 11 hours 1 minute 9 seconds'

prettyMs(95_500, { colonNotation: true });
// '1:35.5'

prettyMs(100.400080, { formatSubMilliseconds: true });
// '100ms 400µs 80ns'
```

Useful `prettyMs` options include:

- `compact`: show only the first unit.
- `unitCount`: limit how many units appear.
- `verbose`: use full unit names.
- `colonNotation`: format durations like a digital timer.
- `secondsDecimalDigits` and `millisecondsDecimalDigits`: control precision.
- `separateMilliseconds`: show milliseconds as their own unit.
- `formatSubMilliseconds`: include microseconds and nanoseconds.
- `hideYear`, `hideYearAndDays`, and `hideSeconds`: tune which units appear.
- `subSecondsAsDecimals`: present sub-second values as decimal seconds.

## Practical Examples

### CLI Output

```typescript
import { prettyBytes, prettyMs } from '@push.rocks/smartformat';

const transferredBytes = 48_203_991;
const elapsedMs = 8_451;

console.log(`Synced ${prettyBytes(transferredBytes)} in ${prettyMs(elapsedMs)}`);
// Synced 48.2 MB in 8.5s
```

### Aligned Tables

```typescript
import { prettyBytes } from '@push.rocks/smartformat';

const rows = [1_000, 10_000, 100_000].map((bytes) => prettyBytes(bytes, { fixedWidth: 8 }));
// ['    1 kB', '   10 kB', '  100 kB']
```

### Human-Friendly Timers

```typescript
import { prettyMs } from '@push.rocks/smartformat';

const startedAt = Date.now();

// later...
prettyMs(Date.now() - startedAt, { compact: true });
// e.g. '3s'
```

## API

```typescript
export { prettyBytes, prettyMs };
```

The exported functions are direct re-exports from `pretty-bytes` and `pretty-ms`, so their option objects and runtime behavior match those upstream packages.

## Development

```bash
pnpm install
pnpm test
pnpm run build
```

The test suite imports the TypeScript sources directly and verifies the package in the configured `@git.zone/tstest` environment.

## License and Legal Information

This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [LICENSE](./LICENSE) file.

**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.

### Trademarks

This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.

Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.

### Company Information

Task Venture Capital GmbH  
Registered at District Court Bremen HRB 35230 HB, Germany

For any legal inquiries or further information, please contact us via email at hello@task.vc.

By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.