Skip to content

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

@antongolub

Description

@antongolub

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions