Skip to content
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.

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

Typedoc fails on processing package.json files with BOM prefix #1192

Closed
1 task done
antongolub opened this issue Jan 25, 2020 · 2 comments · Fixed by #1193
Closed
1 task done

Typedoc fails on processing package.json files with BOM prefix #1192

antongolub opened this issue Jan 25, 2020 · 2 comments · Fixed by #1193
Labels
bug Functionality does not match expectation

Comments

@antongolub
Copy link
Contributor

This is a very common trouble with paralleljs. For example, bazel-contrib/rules_nodejs#1448

Expected Behavior

typedoc --readme README.md --tsconfig tsconfig.json src/main
Using TypeScript 3.7.5 from ~/project/node_modules/typescript/lib
Rendering [========================================] 100%

Documentation generated at ~/project/docs

Actual Behavior

typedoc --readme README.md --tsconfig tsconfig.json src/main
Error: Could not parse ~/project/node_modules/paralleljs/package.json

Steps to reproduce the bug

  1. Add paralleljs as a dependency or any other package, that has BOM in its files
  2. Run doc generator

Environment

  • Typedoc version: 0.16.8
  • Node.js version: 12.6.0
  • OS: macOS 10.15.2
@antongolub antongolub added the bug Functionality does not match expectation label Jan 25, 2020
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jan 25, 2020

~/project

Totally unrelated, but we should absolutely do this. Either relative to the user directory or the cwd.

Thanks for the report!

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jan 25, 2020

Fix released in 0.16.9

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants