Typedoc выдает ошибку с помощью node_modules package.json - PullRequest
0 голосов
/ 23 октября 2018

Я довольно новичок в использовании Typedoc, и у меня возникают проблемы с ошибкой.

Когда я запускаю Typedoc в моем проекте, документ генерируется правильно, но я также получаю ошибку:

$ ./node_modules/.bin/typedoc --mode file --module commonjs --out ./docs/typescript --target es5 src/ Error: Could not parse /home/michael/workspace/test/node_modules/paralleljs/package.json

Я не понимаю, почему Typedoc просматривает node_modules /, в то время как я указывал генерировать документы на src / (оба находятся на одном уровне).

Я также пыталсяисключить node_modules с --exclude "**/node_modules/**/*" или --externalPattern "**/node_modules/**/*", но, похоже, это ничего не делает.

Если бы кто-то мог помочь / объяснить мне, почему он так себя ведет, я был бы ему благодарен.

1 Ответ

0 голосов
/ 31 октября 2018

Typedoc будет читать информацию о типе из зависимостей проекта, поэтому он смотрит на каталог node_modules.Лучший способ избежать этого - исключить каталог node_modules (см. Ошибку # 313 ).

TypeDoc также просматривает текущего проекта package.jsonфайл, так что также должен быть действительным JSON.

См. также gitter разговор

...