Skip to content

README.md

Latest commit

 

History

History
35 lines (24 loc) · 1.31 KB

README.md

File metadata and controls

35 lines (24 loc) · 1.31 KB

Configuration Generator

@tooling/zod2md-jsdocs:configuration

Usage

nx generate @tooling/zod2md-jsdocs:configuration

By default, the Nx plugin will search for existing configuration files. If they are not present it creates a zod2md.config.ts and adds a target to your project.json file.

You can specify the project explicitly as follows:

nx g @tooling/zod2md-jsdocs:configuration <project-name>

Root/
├── project-name/
│   ├── project.json 👈 updated
│   ├── zod2md.config.ts 👈 generated
│   └── ...
└── ...

Show what will be generated without writing to disk:

nx g configuration ... --dry-run

Options

Name type description
--project string (REQUIRED) The name of the project.
--targetName string (DEFAULT 'zod2md') The id used to identify a target in your project.json.
--skipProject boolean (DEFAULT false) Skip adding the target to project.json.
--skipConfig boolean (DEFAULT false) Skip adding the zod2md.config.ts to project root.