UNPKG

3.31 kBTypeScriptView Raw
1export interface Schema {
2 /**
3 * Initial git repository commit information.
4 */
5 commit?: CommitUnion;
6 /**
7 * When true (the default), creates a new initial app project in the src folder of the new
8 * workspace. When false, creates an empty workspace with no initial app. You can then use
9 * the generate application command so that all apps are created in the projects folder.
10 */
11 createApplication?: boolean;
12 /**
13 * The directory name to create the workspace in.
14 */
15 directory?: string;
16 /**
17 * When true, includes styles inline in the component TS file. By default, an external
18 * styles file is created and referenced in the component TS file.
19 */
20 inlineStyle?: boolean;
21 /**
22 * When true, includes template inline in the component TS file. By default, an external
23 * template file is created and referenced in the component TS file.
24 */
25 inlineTemplate?: boolean;
26 /**
27 * When true, links the CLI to the global version (internal development only).
28 */
29 linkCli?: boolean;
30 /**
31 * When true, creates a project without any testing frameworks. (Use for learning purposes
32 * only.)
33 */
34 minimal?: boolean;
35 /**
36 * The name of the new workspace and initial project.
37 */
38 name: string;
39 /**
40 * The path where new projects will be created, relative to the new workspace root.
41 */
42 newProjectRoot?: string;
43 /**
44 * The package manager used to install dependencies.
45 */
46 packageManager?: PackageManager;
47 /**
48 * The prefix to apply to generated selectors for the initial project.
49 */
50 prefix?: string;
51 /**
52 * When true, generates a routing module for the initial project.
53 */
54 routing?: boolean;
55 /**
56 * When true, does not initialize a git repository.
57 */
58 skipGit?: boolean;
59 /**
60 * When true, does not install dependency packages.
61 */
62 skipInstall?: boolean;
63 /**
64 * When true, does not generate "spec.ts" test files for the new project.
65 */
66 skipTests?: boolean;
67 /**
68 * Creates a workspace with stricter TypeScript compiler options.
69 */
70 strict?: boolean;
71 /**
72 * The file extension or preprocessor to use for style files.
73 */
74 style?: Style;
75 /**
76 * The version of the Angular CLI to use.
77 */
78 version: string;
79 /**
80 * The view encapsulation strategy to use in the initial project.
81 */
82 viewEncapsulation?: ViewEncapsulation;
83}
84/**
85 * Initial git repository commit information.
86 */
87export declare type CommitUnion = boolean | CommitObject;
88export interface CommitObject {
89 email: string;
90 message?: string;
91 name: string;
92}
93/**
94 * The package manager used to install dependencies.
95 */
96export declare enum PackageManager {
97 Cnpm = "cnpm",
98 Npm = "npm",
99 Pnpm = "pnpm",
100 Yarn = "yarn"
101}
102/**
103 * The file extension or preprocessor to use for style files.
104 */
105export declare enum Style {
106 Css = "css",
107 Less = "less",
108 Sass = "sass",
109 Scss = "scss",
110 Styl = "styl"
111}
112/**
113 * The view encapsulation strategy to use in the initial project.
114 */
115export declare enum ViewEncapsulation {
116 Emulated = "Emulated",
117 Native = "Native",
118 None = "None",
119 ShadowDom = "ShadowDom"
120}