PeculiarVentures / json-schema / 38873978477

100%

push

github

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

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

Align the build with @peculiar/utils 4 (pvtsutils): ESM-only tsdown
output with the existing copyright banner, attw esm-only profile,
engines-driven syntax target, pvtsutils tsconfig (plus
experimentalDecorators for @JsonProp), oxlint/oxfmt, vitest, editor and
.gitignore configs. Config files are now .ts. Use type-only imports
required by verbatimModuleSyntax, add a public-API smoke test in
src/index.spec.ts, drop @types/node (no Node.js APIs are used) and
update the devDependencies.

BREAKING CHANGE: @peculiar/json-schema is ESM-only. The CommonJS build
(build/index.js as CJS, build/index.mjs, build/index.d.mts and the
require export condition) is removed; the package now ships
build/index.js as ESM with build/index.d.ts. Node.js ^20.19.0 ||
>=22.12.0 is required (previously >=16.0.0). CommonJS code can still
require("@peculiar/json-schema") on those versions through require(esm).
TypeScript projects that compile to CommonJS need "module": "node20" or
"nodenext".

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

* build: emit unbundled output

Emit one file per source module, as pvtsutils does, so the published
build mirrors src/ and is easier to debug. The exports map is unchanged:
only build/index.js is reachable. Document the layout in CONTRIBUTING.md
and note in the README that the v2 bundled declarations leaked four
internal types, which v3 no longer exports.

203 of 203 branches covered (100.0%)

Branch coverage included in aggregate %.

237 of 237 relevant lines covered (100.0%)

50.16 hits per line