ParsedArgs

The parsed command line. undefined means "not given": the prompts or defaults decide.

Import#

import type { ParsedArgs } from "create-shadow-app";

Signature#

interface ParsedArgs {
  directory: string | undefined;
  name: string | undefined;
  template: TemplateName | undefined;
  /** Add-ons switched on (`true`) or off (`false`) by flags. */
  addons: Partial<Record<AddonName | "router", boolean>>;
  yes: boolean;
  /** `false` after `--no-install`. */
  install: boolean | undefined;
  /** `false` after `--no-git`. */
  git: boolean | undefined;
  packageManager: PackageManager | undefined;
  /** `--adapter`: the deployment target of the `dusk` template. */
  adapter: AdapterName | undefined;
  force: boolean;
  dryRun: boolean;
  local: string | undefined;
  packRoot: string | undefined;
  allowOutside: boolean;
  /** `--json`: one JSON document on stdout instead of words; nothing is asked. */
  json: boolean;
  help: boolean;
  version: boolean;
}

Members#

Name	Type	Description
`directory`	`directory: string \| undefined`
`name`	`name: string \| undefined`
`template`	`template: TemplateName \| undefined`
`addons`	`addons: Partial<Record<AddonName \| "router", boolean>>`	Add-ons switched on (`true`) or off (`false`) by flags.
`yes`	`yes: boolean`
`install`	`install: boolean \| undefined`	`false` after `--no-install`.
`git`	`git: boolean \| undefined`	`false` after `--no-git`.
`packageManager`	`packageManager: PackageManager \| undefined`
`adapter`	`adapter: AdapterName \| undefined`	`--adapter`: the deployment target of the `dusk` template.
`force`	`force: boolean`
`dryRun`	`dryRun: boolean`
`local`	`local: string \| undefined`
`packRoot`	`packRoot: string \| undefined`
`allowOutside`	`allowOutside: boolean`
`json`	`json: boolean`	`--json`: one JSON document on stdout instead of words; nothing is asked.
`help`	`help: boolean`
`version`	`version: boolean`