scaffold
Writes a new project into directory.
Writes a new project into directory. Refuses to touch an existing non-empty directory.
Import#
ts
import { scaffold } from "create-shadow-app";
Signature#
ts
function scaffold(directory: string, options: ScaffoldOptions): ScaffoldResult
Parameters#
| Name | Description |
|---|---|
directory |
Where to write; created when missing. |
options |
What to generate. |
Returns#
The absolute directory and the relative paths written.
Throws#
- Error when the directory is not empty or the name is invalid (the message says why).
Examples#
ts
scaffold("my-app", { name: "my-app", template: "dusk", tailwind: true });