Установка
Поставьте пакет и убедитесь, что peer-зависимости на месте.
Пакет
bash
npm install nestjs-docfyPeer-зависимости
Peer-зависимости (в любом проекте NestJS они уже есть):
bash
npm install @nestjs/common @nestjs/swagger reflect-metadataМинимальные версии: @nestjs/common >=9, @nestjs/swagger >=6, reflect-metadata.
Требуется Node.js 22.12 или новее.
CLI и плагин компилятора
CLI и плагин компилятора — инструменты сборки. Установите их зависимости как dev-зависимости:
bash
npm install --save-dev ts-morph commander picocolors
# only needed for `nestjs-docfy generate-client`:
npm install --save-dev openapi-typescriptС 0.19 это опциональные peer-зависимости, поэтому приложение, использующее только DocfyModule и DocfyUiModule, не несёт компилятор TypeScript в продакшен. Без них CLI выводит команду установки. См. Безопасность и миграция.