docfy init

一条命令完成引导配置：接入 DocfyModule、为控制器添加装饰器、必要时注册 webpack 插件、向 package.json 添加脚本，并生成文档文件。

用法

bash
npx nestjs-docfy init [options]

最快达成可用配置的方式——整合了 generate --link-controller --register-plugin 已经完成的工作，外加唯一的新步骤：将 DocfyModule.forRoot() 接入根模块。

功能说明

  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.

选项

OptionDefaultDescription
--root <path>.Project root directory
--tsconfig <path>auto-detectedPath to tsconfig.json
--pattern <glob>**/*.controller.tsGlob pattern to find controllers
--formattsOutput format: ts or js
--dry-runfalsePrint what would change without writing any files
--quietfalseSuppress all output except errors