docfy init

Utilizzo

npx nestjs-docfy init [options]

Il percorso più rapido verso una configurazione funzionante — riunisce ciò che generate --link-controller --register-plugin già fanno, più l'unico passo nuovo: collegare DocfyModule.forRoot() al modulo radice.

Cosa fa

1. Locates each app's bootstrap file and the class passed to NestFactory.create(...), then wires DocfyModule.forRoot() into that root module's @Module({ imports: [...] }). Static analysis only — never executes your code. If it can't locate the bootstrap file or the module with certainty, it warns and skips that app instead of guessing.
2. Runs the same steps as generate --link-controller --register-plugin: decorates every controller with @WithDocs(), registers the webpack CLI plugin if needed, and generates the companion *.controller.docs.ts files.
3. Adds docs:generate/docs:preview scripts to the root package.json, without overwriting any script already defined under those names.

Every step is independently idempotent, so running init again is always safe — useful after adding a new controller or a second app to the project. See CLI: generate for what each bundled step does on its own.

Opzioni