PeculiarVentures / ByteStream.js / 38896574175

80%

Build Type

push

github

Committed by web-flow

Commit Message

build!: ship ESM-only output for Node.js ^20.19.0 || >=22.12.0 (#22)

* build!: ship ESM-only output for Node.js ^20.19.0 || >=22.12.0

Build with tsdown (pvtsutils config, single entry, platform neutral)
instead of three tsc passes into build/cjs, build/mjs and build/types.
The package is "type": "module" with an exports map generated by
tsdown, and engines.node is ^20.19.0 || >=22.12.0.

Adopt the pvtsutils tsconfig (verbatimModuleSyntax, es2023, noEmit), so
type-only imports use import type. Drop rimraf and @types/node (no
Node.js APIs in the source or tests), update the dev dependencies and
take the pvtsutils .gitignore and VS Code settings.

BREAKING CHANGE: bytestreamjs is ESM-only and requires Node.js
^20.19.0 || >=22.12.0. build/cjs, build/mjs and build/types are
replaced by ES modules in build/ behind an exports map that blocks deep
imports.

* test: colocate specs with the sources

Split test/funcTest.spec.ts into src/<module>.spec.ts files with the
same tests and assertions, and use the pvtsutils vitest config.

* chore: adopt the pvtsutils oxlint and oxfmt configs

Keep the two rules the previous config turned off
(no-constant-condition, unicorn/no-new-array): fixing them changes
runtime code.

* style: format with oxfmt

* test: add a public API smoke test

* docs: document v3 breaking changes and add CONTRIBUTING.md

Coverage Stats

423 of 560 branches covered (75.54%)

Branch coverage included in aggregate %.

9 of 10 new or added lines in 3 files covered. (90.0%)

1 existing line in 1 file now uncovered.

753 of 918 relevant lines covered (82.03%)

96.75 hits per line