Skip to content

fix: restore modern npm install tooling - #8

Open
ManuelSalcedo2770 wants to merge 1 commit into
BitgesellOfficial:mainfrom
ManuelSalcedo2770:fix/modern-npm-install-tooling
Open

fix: restore modern npm install tooling#8
ManuelSalcedo2770 wants to merge 1 commit into
BitgesellOfficial:mainfrom
ManuelSalcedo2770:fix/modern-npm-install-tooling

Conversation

@ManuelSalcedo2770

Copy link
Copy Markdown

Summary

  • Update Jest-related TypeScript tooling so the package installs cleanly with normal npm ci.
  • Update TypeDoc to a version compatible with the repository's TypeScript range.
  • Remove obsolete TypeDoc CLI flags so npm run doc:json works with the updated TypeDoc release.

Why

A fresh install currently fails before tests can run because jest@29 is paired with ts-jest@27. After aligning ts-jest, the stale TypeDoc peer range also conflicts with the lockfile's TypeScript 4.9 resolution. This PR keeps the fix scoped to development tooling and docs generation.

Verification

  • npm ci
  • npm run build
  • npm test -- --runInBand --coverage=false (5 suites, 22 tests passing)
  • npm run doc:json
  • git diff --check

Submitted for the Bitgesell PR bounty hunt: BitgesellOfficial/bitgesell#39. Payout details can be provided after maintainer review/approval.

@MyTH-zyxeon

Copy link
Copy Markdown

Maintainer review-assist for #39:

I checked the current diff and public PR surface. This PR is OPEN/MERGEABLE, has no existing conversation comments or review threads, changes only package.json and package-lock.json, and GitHub does not expose any status contexts/workflow runs for the head SHA right now.

Suggested acceptance checks:

  • Jest tooling is now aligned as a set: ts-jest moves to 29.x and @types/jest to 29.x while the lock keeps typescript at 4.9.5. That should match the existing Jest 29 tree; the useful maintainer check is that no Jest config or transform path still assumes the old ts-jest 27 behavior.
  • TypeDoc is upgraded from 0.19 to 0.25 and the removed --target / --mode flags are dropped. The key check is that both npm run doc:json and npm run doc:html still write under build/docs, since doc:publish depends on that directory.
  • The lockfile shrink looks consistent with removing the older Jest 27 / TypeDoc 0.19 optional dependency tree; runtime package dependencies are not being changed.
  • Because no CI status is visible on the PR, the listed local verification commands (npm ci, npm run build, focused/full test command, npm run doc:json) are the evidence to confirm before accepting the bounty.

If those commands reproduce cleanly for a maintainer, this looks like a focused tooling unblock rather than an SDK behavior change.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants