Project

A composed project.

Import#

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

Signature#

interface Project {
  /** The choices after defaults and implications ({@link resolveOptions}). */
  readonly options: ResolvedOptions;
  /** Every file: relative POSIX path to content. */
  readonly files: Map<string, string>;
  /** The install as commands to type, for the README and the next steps. */
  readonly installCommands: readonly string[];
  /** Steps after `cd` and install, for the "next steps" list. */
  readonly steps: readonly string[];
  /** The scripts of the root `package.json`. */
  readonly scripts: Readonly<Record<string, string>>;
}

Members#

Name	Type	Description
`options`	`readonly options: ResolvedOptions`	The choices after defaults and implications (resolveOptions).
`files`	`readonly files: Map<string, string>`	Every file: relative POSIX path to content.
`installCommands`	`readonly installCommands: readonly string[]`	The install as commands to type, for the README and the next steps.
`steps`	`readonly steps: readonly string[]`	Steps after `cd` and install, for the "next steps" list.
`scripts`	`readonly scripts: Readonly<Record<string, string>>`	The scripts of the root `package.json`.