Skip to content

build: migrate bundling from rollup+tsc to tsdown #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alexvictoor wants to merge 1 commit into
base: master
Choose a base branch
from
Open

build: migrate bundling from rollup+tsc to tsdown #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 30 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -333,18 +333,28 @@ console.log(histogram.estimatedFootprintInBytes);

# Tree Shaking

The above examples use a convenient 'barrel' index file. Using this barrel, you cannot leverage on the tree shaking features of your favorite bundler. Hence the size of your JavaScript bundle may increase significantly. If you need to optimize the size of your bundle, you can import HdrHistogram modules as shown in code fragment below:
HdrHistogramJS ships as an ES module and is flagged `"sideEffects": false`, so modern
bundlers (Rollup, esbuild, webpack, Vite, tsdown, ...) tree-shake it automatically.
Just import the named exports you actually use from the package entry point, and
unused histogram types, iterators and the inlined WebAssembly module are dropped from
your bundle:

```ts
import Int32Histogram from "hdr-histogram-js/dist/Int32Histogram"
import { Int32Histogram } from "hdr-histogram-js";

const histogram = new Int32Histogram(1, 2, 3);
histogram.autoResize = true;

histogram.recordValue(...);

```

For example, importing only `Int32Histogram` produces a bundle **without** the ~33 kB
WebAssembly blob, whereas using `build({ useWebAssembly: true })` pulls it in — you pay
only for what you use.

> Deep imports such as `hdr-histogram-js/dist/Int32Histogram` are no longer needed:
> named imports from `"hdr-histogram-js"` give you the same tree-shaking benefit.

# Migrating from v3 to v4

Version 4.0.0 drops the `pako` dependency and uses the runtime-native
Expand All @@ -357,9 +367,9 @@ breaking changes:
anymore. If you were adding `pako` to your page or bundle for browser usage, you can
remove it.

**2. Node.js 18+ / modern browsers required.** The Compression Streams API is
**2. Node.js 22+ / modern browsers required.** The Compression Streams API is
_Baseline: widely available_ (Chrome 80+, Firefox 113+, Safari 16.4+, Node 18+).
`engines.node` is now `>=18`.
`engines.node` is now `>=22`.

**3. Encoding & decoding are now asynchronous.** The native API is async-only, so the
following now return promises — add `await` (or chain `.then()`):
Expand Down Expand Up @@ -395,6 +405,21 @@ await hdr.initWebAssembly();
accepts it for source compatibility, but the native API exposes no level option, so it
has no effect.

**6. Dual ESM/CommonJS package with a proper `exports` map.** v4 ships true ES modules
(`import`) alongside CommonJS (`require`), a UMD browser build, and bundled type
definitions, all resolved through the package `exports` field. Standard imports are
unchanged:

```ts
import * as hdr from "hdr-histogram-js"; // ESM
// or
const hdr = require("hdr-histogram-js"); // CommonJS
```

Deep imports into internal files such as `hdr-histogram-js/dist/Int32Histogram` are no
longer supported — import the named exports from the package entry point instead (see
[Tree Shaking](#tree-shaking)); they are tree-shaken just as well.

# Migrating from v1 to v2

For most users, migration from HdrHistogramJS v1 to v2 should be smooth. However since HdrHistogramJS v2 does not stick anymore with HdrHistogram Java API, you might run into some breaking changes.
Expand Down
Loading
Loading