Skip to content

marmotte / cli/setup

cli/setup

Type Aliases

SetupOptions

SetupOptions = object

Defined in: src/cli/setup.ts:8

Options for runSetup. All fields are optional; missing ones are prompted interactively.

Properties

dir?

optional dir: string

Defined in: src/cli/setup.ts:10

Working directory of the target project. Defaults to process.cwd().

features?

optional features: string[]

Defined in: src/cli/setup.ts:12

Feature IDs to apply (e.g. ["lint", "format"]). When provided, skips the feature prompt.

Functions

runSetup()

runSetup(opts?): Promise<void>

Defined in: src/cli/setup.ts:31

Add tooling features to an existing project.

Reads the project's package.json, applies each selected feature (adding scripts and devDependencies), writes the updated package.json, then runs npm install.

Parameters

opts?

SetupOptions = {}

Returns

Promise<void>

Examples

ts
await runSetup(); // prompts for features
ts
await runSetup({ features: ["lint", "format"] });