Включение файла пакета

Файлы пакетов содержат информацию, которая может быть полезна для документации вашего проекта, например, имя проекта и номер версии. JSDoc может автоматически использовать информацию из файла package.json вашего проекта при генерации документации. Например, шаблон по умолчанию отображает имя и номер версии проекта в документации.

Есть два способа включить файл package.json в вашу документацию:

1. В пути к вашим JavaScript-файлам включите путь к файлу package.json. JSDoc будет использовать первый файл package.json, который найдет в ваших путях к исходным файлам.
2. Запустите JSDoc с опцией командной строки -P/--package, указав путь к вашему файлу package.json. Эта опция доступна в JSDoc 3.3.0 и более поздних версиях.

Опция командной строки -P/--package имеет приоритет над вашими путями к исходным файлам. Если вы используете опцию командной строки -P/--package, JSDoc проигнорирует любые файлы package.json в ваших путях к исходным файлам.

Файл package.json должен использовать формат пакета npm.

Примеры

jsdoc path/to/js path/to/package/package.json

jsdoc --package path/to/package/package-docs.json path/to/js