build:apidoc fails

Open
#17,550 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
35/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Stale
Tech stack
node.js, typescript
Domain
build-system

Research direction

Start by inspecting the package scripts behind pnpm run build:apidoc and the related build:themedoc command, then read scripts/build-apidoc.ts and scripts/build-themedoc.ts. Verify the commands' TypeScript execution setup and run pnpm run build:apidoc; done means the command completes without failing.

Written by the indexing model from the issue text.

Description

Resolution: Stale Status: Needs Triage
Describe the bug

pnpm run build:apidoc fails, because npm run build:apidoc && npm run build:themedoc are trying to execute the scripts/build-apidoc.ts and scripts/build-themedoc.ts directly via node.

The typescript files could be executed with ts-node or tsx. From node@23 upwards there is an experimental flag to execute ts directly but for the moment I would stick with tsx.

I would recomend tsxover ts-node for simplicity and perrformance reasons.

Pull Request Link

No response

Reason for not contributing a PR
  • Lack of time
  • Unsure how to implement the fix/feature
  • Difficulty understanding the codebase
  • Other
Other Reason

No response

Reproducer
Environment

Ubuntu 24
node 22

Angular version

19

PrimeNG version

v19

Node version

22

Browser(s)

No response

Steps to reproduce the behavior

Runningpnpm run build:apidoc fails.

Expected behavior

pnpm run build:apidoc should not fail.

Dominant language
TypeScript
Stars
12.5k
Forks
5.1k
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from primefaces/primeng

All issues in primefaces/primeng

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.