@eljs/create

Create a project from a remote template.

Installation

1$ npm i @eljs/create -g

Usage

1$ create <template> <project-name>
2// or
3$ npx @eljs/create <template> <project-name>

1Usage: create [options] <template> <project-name>
2
3Options:
4  -v, --version   Output the current version
5  --cwd <cwd>     Specify the working directory
6  -f, --force     Overwrite target directory if it exists
7  -m, --merge     Merge target directory if it exists
8  --no-install    Skip install dependencies after create done
9  -h, --help      display help for command

Configuration

Create a create.config.ts file in the project root.

1export interface Config {
2  /**
3   * Working directory
4   * @default process.cwd()
5   */
6  cwd?: string
7  /**
8   * Local template path or remote template
9   */
10  template?: string | Template
11  /**
12   * Whether overwrite target directory if it exists
13   * @default false
14   */
15  force?: boolean
16  /**
17   * Whether merge target directory if it exists
18   * @default false
19   */
20  merge?: boolean
21  /**
22   * Whether enable default prompts
23   * @default true
24   */
25  defaultQuestions?: boolean
26  /**
27   * Whether initialize git after create done
28   * @default true
29   */
30  gitInit?: boolean
31  /**
32   * Whether install dependencies after create done
33   * @default true
34   */
35  install?: boolean
36  /**
37   * Preset definitions
38   */
39  presets?: PluginDeclaration[]
40  /**
41   * Plugin definitions
42   */
43  plugins?: PluginDeclaration[]
44}
45
46/**
47 * Remote Template
48 */
49export interface RemoteTemplate {
50  /**
51   * Template type
52   */
53  type: 'npm' | 'git'
54  /**
55   * Template value
56   */
57  value: string
58  /**
59   * Npm registry
60   */
61  registry?: string
62}