@zuke/nest

`@zuke/nest` — typed NestJS CLI (`nest`) task wrappers for Zuke builds.

Symbols

# NestBuildSettings class

class NestBuildSettings extends NestSettings

Settings for nest build — compile a NestJS application.

Member	Signature	Doc
`app`	`app(value: string): this`	The application/project to build (positional, optional).
`config`	`config(path: PathLike): this`	Path to the Nest CLI configuration file (`--config <p>`).
`path`	`path(path: PathLike): this`	Path to the `tsconfig` file (`--path <p>`).
`watch`	`watch(): this`	Rebuild on file changes (`--watch`).
`webpack`	`webpack(): this`	Use the webpack builder (`--webpack`).
`tsc`	`tsc(): this`	Use the `tsc` builder (`--tsc`).
`builder`	`builder(value: string): this`	Builder to use, e.g. `tsc`/`webpack`/`swc` (`--builder <v>`).
`preserveWatchOutput`	`preserveWatchOutput(): this`	Keep prior console output between watch rebuilds (`--preserveWatchOutput`).

# NestGenerateSettings class

class NestGenerateSettings extends NestSettings

Settings for nest generate — generate code from a schematic.

Member	Signature	Doc
`schematic`	`schematic(value: string): this`	The schematic to generate, e.g. `module`/`service` (positional, required).
`name`	`name(value: string): this`	The name passed to the schematic (positional, optional).
`project`	`project(value: string): this`	Target project in a monorepo (`--project <v>`).
`collection`	`collection(value: string): this`	Schematics collection to use (`--collection <v>`).
`flat`	`flat(): this`	Generate files without a dedicated directory (`--flat`).
`spec`	`spec(): this`	Force generation of a spec file (`--spec`).
`noSpec`	`noSpec(): this`	Disable generation of a spec file (`--no-spec`).
`skipImport`	`skipImport(): this`	Skip importing the generated element into its module (`--skip-import`).
`dryRun`	`dryRun(): this`	Report what would be generated without writing files (`--dry-run`).

# NestInfoSettings class

class NestInfoSettings extends NestSettings

Settings for nest info — print Nest CLI and project information.

# NestNewSettings class

class NestNewSettings extends NestSettings

Settings for nest new — scaffold a new NestJS application.

Member	Signature	Doc
`name`	`name(value: string): this`	The application name (positional, required).
`directory`	`directory(path: PathLike): this`	Generate into this directory (`--directory <p>`).
`skipInstall`	`skipInstall(): this`	Skip package installation (`--skip-install`).
`skipGit`	`skipGit(): this`	Skip git repository initialization (`--skip-git`).
`strict`	`strict(): this`	Enable TypeScript strict mode in the generated project (`--strict`).
`dryRun`	`dryRun(): this`	Report what would be generated without writing files (`--dry-run`).
`packageManager`	`packageManager(value: string): this`	Package manager to use, e.g. `npm`/`yarn`/`pnpm` (`--package-manager <v>`).
`language`	`language(value: string): this`	Programming language, e.g. `ts`/`js` (`--language <v>`).

# NestSettings class

class NestSettings extends ToolSettings

Shared base for every nest subcommand: the binary and argv assembly.

# NestStartSettings class

class NestStartSettings extends NestSettings

Settings for nest start — build and run a NestJS application.

Member	Signature	Doc
`app`	`app(value: string): this`	The application/project to start (positional, optional).
`config`	`config(path: PathLike): this`	Path to the Nest CLI configuration file (`--config <p>`).
`path`	`path(path: PathLike): this`	Path to the `tsconfig` file (`--path <p>`).
`watch`	`watch(): this`	Rebuild and restart on file changes (`--watch`).
`debug`	`debug(): this`	Start in debug mode (`--debug`).
`preserveWatchOutput`	`preserveWatchOutput(): this`	Keep prior console output between watch rebuilds (`--preserveWatchOutput`).
`exec`	`exec(value: string): this`	Binary used to run the compiled output (`--exec <v>`).
`builder`	`builder(value: string): this`	Builder to use, e.g. `tsc`/`webpack`/`swc` (`--builder <v>`).

# NestTasks const

const NestTasks: NestTasksApi

Typed task functions for the NestJS CLI (nest).

# NestTasksApi interface

interface NestTasksApi

The shape of NestTasks.

Member	Signature	Doc
`new`	`new(configure?: Configure<NestNewSettings>): Promise<CommandOutput>`	Scaffold a new application: `nest new`.
`generate`	`generate(configure?: Configure<NestGenerateSettings>): Promise<CommandOutput>`	Generate code from a schematic: `nest generate`.
`build`	`build(configure?: Configure<NestBuildSettings>): Promise<CommandOutput>`	Compile an application: `nest build`.
`start`	`start(configure?: Configure<NestStartSettings>): Promise<CommandOutput>`	Build and run an application: `nest start`.
`info`	`info(configure?: Configure<NestInfoSettings>): Promise<CommandOutput>`	Print CLI and project information: `nest info`.