UNPKG

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