source: trip-planner-front/node_modules/@angular/cli/lib/config/workspace-schema.d.ts@ 76712b2

Last change on this file since 76712b2 was 6a3a178, checked in by Ema <ema_spirova@…>, 3 years ago

initial commit

  • Property mode set to 100644
File size: 20.4 KB
Line 
1export interface Schema {
2 $schema?: string;
3 cli?: CliOptions;
4 /**
5 * Default project name used in commands.
6 */
7 defaultProject?: string;
8 /**
9 * Path where new projects will be created.
10 */
11 newProjectRoot?: string;
12 projects?: Projects;
13 schematics?: SchematicOptions;
14 version: number;
15}
16export interface CliOptions {
17 /**
18 * Share anonymous usage data with the Angular Team at Google.
19 */
20 analytics?: Analytics;
21 analyticsSharing?: AnalyticsSharing;
22 /**
23 * The default schematics collection to use.
24 */
25 defaultCollection?: string;
26 /**
27 * Specify which package manager tool to use.
28 */
29 packageManager?: PackageManager;
30 /**
31 * Control CLI specific console warnings
32 */
33 warnings?: Warnings;
34}
35/**
36 * Share anonymous usage data with the Angular Team at Google.
37 */
38export declare type Analytics = boolean | string;
39export interface AnalyticsSharing {
40 /**
41 * Analytics sharing info tracking ID.
42 */
43 tracking?: string;
44 /**
45 * Analytics sharing info universally unique identifier.
46 */
47 uuid?: string;
48}
49/**
50 * Specify which package manager tool to use.
51 *
52 * The package manager used to install dependencies.
53 */
54export declare enum PackageManager {
55 Cnpm = "cnpm",
56 Npm = "npm",
57 Pnpm = "pnpm",
58 Yarn = "yarn"
59}
60/**
61 * Control CLI specific console warnings
62 */
63export interface Warnings {
64 /**
65 * Show a warning when the global version is newer than the local one.
66 */
67 versionMismatch?: boolean;
68}
69export interface Projects {
70}
71export interface SchematicOptions {
72 "@schematics/angular:application"?: AngularApplicationOptionsSchema;
73 "@schematics/angular:class"?: AngularClassOptionsSchema;
74 "@schematics/angular:component"?: AngularComponentOptionsSchema;
75 "@schematics/angular:directive"?: AngularDirectiveOptionsSchema;
76 "@schematics/angular:enum"?: AngularEnumOptionsSchema;
77 "@schematics/angular:guard"?: AngularGuardOptionsSchema;
78 "@schematics/angular:interceptor"?: AngularInterceptorOptionsSchema;
79 "@schematics/angular:interface"?: AngularInterfaceOptionsSchema;
80 "@schematics/angular:library"?: LibraryOptionsSchema;
81 "@schematics/angular:ng-new"?: AngularNgNewOptionsSchema;
82 "@schematics/angular:pipe"?: AngularPipeOptionsSchema;
83 "@schematics/angular:resolver"?: AngularResolverOptionsSchema;
84 "@schematics/angular:service"?: AngularServiceOptionsSchema;
85 "@schematics/angular:web-worker"?: AngularWebWorkerOptionsSchema;
86}
87/**
88 * Generates a new basic app definition in the "projects" subfolder of the workspace.
89 */
90export interface AngularApplicationOptionsSchema {
91 /**
92 * Include styles inline in the root component.ts file. Only CSS styles can be included
93 * inline. Default is false, meaning that an external styles file is created and referenced
94 * in the root component.ts file.
95 */
96 inlineStyle?: boolean;
97 /**
98 * Include template inline in the root component.ts file. Default is false, meaning that an
99 * external template file is created and referenced in the root component.ts file.
100 */
101 inlineTemplate?: boolean;
102 /**
103 * Add support for legacy browsers like Internet Explorer using differential loading.
104 * @deprecated Legacy browsers support is deprecated since version 12. For more information,
105 * see https://angular.io/guide/browser-support
106 */
107 legacyBrowsers?: boolean;
108 /**
109 * Apply lint fixes after generating the application.
110 * @deprecated Use "ng lint --fix" directly instead.
111 */
112 lintFix?: boolean;
113 /**
114 * Create a bare-bones project without any testing frameworks. (Use for learning purposes
115 * only.)
116 */
117 minimal?: boolean;
118 /**
119 * The name of the new app.
120 */
121 name: string;
122 /**
123 * A prefix to apply to generated selectors.
124 */
125 prefix?: string;
126 /**
127 * The root directory of the new app.
128 */
129 projectRoot?: string;
130 /**
131 * Create a routing NgModule.
132 */
133 routing?: boolean;
134 /**
135 * Skip installing dependency packages.
136 */
137 skipInstall?: boolean;
138 /**
139 * Do not add dependencies to the "package.json" file.
140 */
141 skipPackageJson?: boolean;
142 /**
143 * Do not create "spec.ts" test files for the application.
144 */
145 skipTests?: boolean;
146 /**
147 * Creates an application with stricter bundle budgets settings.
148 */
149 strict?: boolean;
150 /**
151 * The file extension or preprocessor to use for style files.
152 */
153 style?: SchematicsAngularApplicationStyle;
154 /**
155 * The view encapsulation strategy to use in the new application.
156 */
157 viewEncapsulation?: ViewEncapsulation;
158}
159/**
160 * The file extension or preprocessor to use for style files.
161 */
162export declare enum SchematicsAngularApplicationStyle {
163 Css = "css",
164 Less = "less",
165 Sass = "sass",
166 Scss = "scss"
167}
168/**
169 * The view encapsulation strategy to use in the new application.
170 *
171 * The view encapsulation strategy to use in the new component.
172 *
173 * The view encapsulation strategy to use in the initial project.
174 */
175export declare enum ViewEncapsulation {
176 Emulated = "Emulated",
177 None = "None",
178 ShadowDom = "ShadowDom"
179}
180/**
181 * Creates a new, generic class definition in the given or default project.
182 */
183export interface AngularClassOptionsSchema {
184 /**
185 * Apply lint fixes after generating the class.
186 * @deprecated Use "ng lint --fix" directly instead.
187 */
188 lintFix?: boolean;
189 /**
190 * The name of the new class.
191 */
192 name: string;
193 /**
194 * The path at which to create the class, relative to the workspace root.
195 */
196 path?: string;
197 /**
198 * The name of the project.
199 */
200 project?: string;
201 /**
202 * Do not create "spec.ts" test files for the new class.
203 */
204 skipTests?: boolean;
205 /**
206 * Adds a developer-defined type to the filename, in the format "name.type.ts".
207 */
208 type?: string;
209}
210/**
211 * Creates a new, generic component definition in the given or default project.
212 */
213export interface AngularComponentOptionsSchema {
214 /**
215 * The change detection strategy to use in the new component.
216 */
217 changeDetection?: ChangeDetection;
218 /**
219 * Specifies if the style will contain `:host { display: block; }`.
220 */
221 displayBlock?: boolean;
222 /**
223 * The declaring NgModule exports this component.
224 */
225 export?: boolean;
226 /**
227 * Create the new files at the top level of the current project.
228 */
229 flat?: boolean;
230 /**
231 * Include styles inline in the component.ts file. Only CSS styles can be included inline.
232 * By default, an external styles file is created and referenced in the component.ts file.
233 */
234 inlineStyle?: boolean;
235 /**
236 * Include template inline in the component.ts file. By default, an external template file
237 * is created and referenced in the component.ts file.
238 */
239 inlineTemplate?: boolean;
240 /**
241 * Apply lint fixes after generating the component.
242 * @deprecated Use "ng lint --fix" directly instead.
243 */
244 lintFix?: boolean;
245 /**
246 * The declaring NgModule.
247 */
248 module?: string;
249 /**
250 * The name of the component.
251 */
252 name: string;
253 /**
254 * The path at which to create the component file, relative to the current workspace.
255 * Default is a folder with the same name as the component in the project root.
256 */
257 path?: string;
258 /**
259 * The prefix to apply to the generated component selector.
260 */
261 prefix?: string;
262 /**
263 * The name of the project.
264 */
265 project?: string;
266 /**
267 * The HTML selector to use for this component.
268 */
269 selector?: string;
270 /**
271 * Do not import this component into the owning NgModule.
272 */
273 skipImport?: boolean;
274 /**
275 * Specifies if the component should have a selector or not.
276 */
277 skipSelector?: boolean;
278 /**
279 * Do not create "spec.ts" test files for the new component.
280 */
281 skipTests?: boolean;
282 /**
283 * The file extension or preprocessor to use for style files, or 'none' to skip generating
284 * the style file.
285 */
286 style?: SchematicsAngularComponentStyle;
287 /**
288 * Adds a developer-defined type to the filename, in the format "name.type.ts".
289 */
290 type?: string;
291 /**
292 * The view encapsulation strategy to use in the new component.
293 */
294 viewEncapsulation?: ViewEncapsulation;
295}
296/**
297 * The change detection strategy to use in the new component.
298 */
299export declare enum ChangeDetection {
300 Default = "Default",
301 OnPush = "OnPush"
302}
303/**
304 * The file extension or preprocessor to use for style files, or 'none' to skip generating
305 * the style file.
306 */
307export declare enum SchematicsAngularComponentStyle {
308 Css = "css",
309 Less = "less",
310 None = "none",
311 Sass = "sass",
312 Scss = "scss"
313}
314/**
315 * Creates a new, generic directive definition in the given or default project.
316 */
317export interface AngularDirectiveOptionsSchema {
318 /**
319 * The declaring NgModule exports this directive.
320 */
321 export?: boolean;
322 /**
323 * When true (the default), creates the new files at the top level of the current project.
324 */
325 flat?: boolean;
326 /**
327 * Apply lint fixes after generating the directive.
328 * @deprecated Use "ng lint --fix" directly instead.
329 */
330 lintFix?: boolean;
331 /**
332 * The declaring NgModule.
333 */
334 module?: string;
335 /**
336 * The name of the new directive.
337 */
338 name: string;
339 /**
340 * The path at which to create the interface that defines the directive, relative to the
341 * workspace root.
342 */
343 path?: string;
344 /**
345 * A prefix to apply to generated selectors.
346 */
347 prefix?: string;
348 /**
349 * The name of the project.
350 */
351 project?: string;
352 /**
353 * The HTML selector to use for this directive.
354 */
355 selector?: string;
356 /**
357 * Do not import this directive into the owning NgModule.
358 */
359 skipImport?: boolean;
360 /**
361 * Do not create "spec.ts" test files for the new class.
362 */
363 skipTests?: boolean;
364}
365/**
366 * Generates a new, generic enum definition for the given or default project.
367 */
368export interface AngularEnumOptionsSchema {
369 /**
370 * Apply lint fixes after generating the enum.
371 * @deprecated Use "ng lint --fix" directly instead.
372 */
373 lintFix?: boolean;
374 /**
375 * The name of the enum.
376 */
377 name: string;
378 /**
379 * The path at which to create the enum definition, relative to the current workspace.
380 */
381 path?: string;
382 /**
383 * The name of the project in which to create the enum. Default is the configured default
384 * project for the workspace.
385 */
386 project?: string;
387 /**
388 * Adds a developer-defined type to the filename, in the format "name.type.ts".
389 */
390 type?: string;
391}
392/**
393 * Generates a new, generic route guard definition in the given or default project.
394 */
395export interface AngularGuardOptionsSchema {
396 /**
397 * When true (the default), creates the new files at the top level of the current project.
398 */
399 flat?: boolean;
400 /**
401 * Specifies which interfaces to implement.
402 */
403 implements?: Implement[];
404 /**
405 * Apply lint fixes after generating the guard.
406 * @deprecated Use "ng lint --fix" directly instead.
407 */
408 lintFix?: boolean;
409 /**
410 * The name of the new route guard.
411 */
412 name: string;
413 /**
414 * The path at which to create the interface that defines the guard, relative to the current
415 * workspace.
416 */
417 path?: string;
418 /**
419 * The name of the project.
420 */
421 project?: string;
422 /**
423 * Do not create "spec.ts" test files for the new guard.
424 */
425 skipTests?: boolean;
426}
427export declare enum Implement {
428 CanActivate = "CanActivate",
429 CanActivateChild = "CanActivateChild",
430 CanDeactivate = "CanDeactivate",
431 CanLoad = "CanLoad"
432}
433/**
434 * Creates a new, generic interceptor definition in the given or default project.
435 */
436export interface AngularInterceptorOptionsSchema {
437 /**
438 * When true (the default), creates files at the top level of the project.
439 */
440 flat?: boolean;
441 /**
442 * Apply lint fixes after generating the interceptor.
443 * @deprecated Use "ng lint --fix" directly instead.
444 */
445 lintFix?: boolean;
446 /**
447 * The name of the interceptor.
448 */
449 name: string;
450 /**
451 * The path at which to create the interceptor, relative to the workspace root.
452 */
453 path?: string;
454 /**
455 * The name of the project.
456 */
457 project?: string;
458 /**
459 * Do not create "spec.ts" test files for the new interceptor.
460 */
461 skipTests?: boolean;
462}
463/**
464 * Creates a new, generic interface definition in the given or default project.
465 */
466export interface AngularInterfaceOptionsSchema {
467 /**
468 * Apply lint fixes after generating the interface.
469 * @deprecated Use "ng lint --fix" directly instead.
470 */
471 lintFix?: boolean;
472 /**
473 * The name of the interface.
474 */
475 name: string;
476 /**
477 * The path at which to create the interface, relative to the workspace root.
478 */
479 path?: string;
480 /**
481 * A prefix to apply to generated selectors.
482 */
483 prefix?: string;
484 /**
485 * The name of the project.
486 */
487 project?: string;
488 /**
489 * Adds a developer-defined type to the filename, in the format "name.type.ts".
490 */
491 type?: string;
492}
493/**
494 * Creates a new, generic library project in the current workspace.
495 */
496export interface LibraryOptionsSchema {
497 /**
498 * The path at which to create the library's public API file, relative to the workspace root.
499 */
500 entryFile?: string;
501 /**
502 * Apply lint fixes after generating the library.
503 * @deprecated Use "ng lint --fix" directly instead.
504 */
505 lintFix?: boolean;
506 /**
507 * The name of the library.
508 */
509 name?: string;
510 /**
511 * A prefix to apply to generated selectors.
512 */
513 prefix?: string;
514 /**
515 * Do not install dependency packages.
516 */
517 skipInstall?: boolean;
518 /**
519 * Do not add dependencies to the "package.json" file.
520 */
521 skipPackageJson?: boolean;
522 /**
523 * Do not update "tsconfig.json" to add a path mapping for the new library. The path mapping
524 * is needed to use the library in an app, but can be disabled here to simplify development.
525 */
526 skipTsConfig?: boolean;
527}
528/**
529 * Creates a new project by combining the workspace and application schematics.
530 */
531export interface AngularNgNewOptionsSchema {
532 /**
533 * Initial git repository commit information.
534 */
535 commit?: CommitUnion;
536 /**
537 * Create a new initial application project in the 'src' folder of the new workspace. When
538 * false, creates an empty workspace with no initial application. You can then use the
539 * generate application command so that all applications are created in the projects folder.
540 */
541 createApplication?: boolean;
542 /**
543 * The directory name to create the workspace in.
544 */
545 directory?: string;
546 /**
547 * Include styles inline in the component TS file. By default, an external styles file is
548 * created and referenced in the component TypeScript file.
549 */
550 inlineStyle?: boolean;
551 /**
552 * Include template inline in the component TS file. By default, an external template file
553 * is created and referenced in the component TypeScript file.
554 */
555 inlineTemplate?: boolean;
556 /**
557 * Add support for legacy browsers like Internet Explorer using differential loading.
558 * @deprecated Legacy browsers support is deprecated since version 12. For more information,
559 * see https://angular.io/guide/browser-support
560 */
561 legacyBrowsers?: boolean;
562 /**
563 * Link the CLI to the global version (internal development only).
564 */
565 linkCli?: boolean;
566 /**
567 * Create a workspace without any testing frameworks. (Use for learning purposes only.)
568 */
569 minimal?: boolean;
570 /**
571 * The name of the new workspace and initial project.
572 */
573 name: string;
574 /**
575 * The path where new projects will be created, relative to the new workspace root.
576 */
577 newProjectRoot?: string;
578 /**
579 * The package manager used to install dependencies.
580 */
581 packageManager?: PackageManager;
582 /**
583 * The prefix to apply to generated selectors for the initial project.
584 */
585 prefix?: string;
586 /**
587 * Generate a routing module for the initial project.
588 */
589 routing?: boolean;
590 /**
591 * Do not initialize a git repository.
592 */
593 skipGit?: boolean;
594 /**
595 * Do not install dependency packages.
596 */
597 skipInstall?: boolean;
598 /**
599 * Do not generate "spec.ts" test files for the new project.
600 */
601 skipTests?: boolean;
602 /**
603 * Creates a workspace with stricter type checking and stricter bundle budgets settings.
604 * This setting helps improve maintainability and catch bugs ahead of time. For more
605 * information, see https://angular.io/guide/strict-mode
606 */
607 strict?: boolean;
608 /**
609 * The file extension or preprocessor to use for style files.
610 */
611 style?: SchematicsAngularApplicationStyle;
612 /**
613 * The version of the Angular CLI to use.
614 */
615 version: string;
616 /**
617 * The view encapsulation strategy to use in the initial project.
618 */
619 viewEncapsulation?: ViewEncapsulation;
620}
621/**
622 * Initial git repository commit information.
623 */
624export declare type CommitUnion = boolean | CommitObject;
625export interface CommitObject {
626 email: string;
627 message?: string;
628 name: string;
629}
630/**
631 * Creates a new, generic pipe definition in the given or default project.
632 */
633export interface AngularPipeOptionsSchema {
634 /**
635 * The declaring NgModule exports this pipe.
636 */
637 export?: boolean;
638 /**
639 * When true (the default) creates files at the top level of the project.
640 */
641 flat?: boolean;
642 /**
643 * Apply lint fixes after generating the pipe.
644 * @deprecated Use "ng lint --fix" directly instead.
645 */
646 lintFix?: boolean;
647 /**
648 * The declaring NgModule.
649 */
650 module?: string;
651 /**
652 * The name of the pipe.
653 */
654 name: string;
655 /**
656 * The path at which to create the pipe, relative to the workspace root.
657 */
658 path?: string;
659 /**
660 * The name of the project.
661 */
662 project?: string;
663 /**
664 * Do not import this pipe into the owning NgModule.
665 */
666 skipImport?: boolean;
667 /**
668 * Do not create "spec.ts" test files for the new pipe.
669 */
670 skipTests?: boolean;
671}
672/**
673 * Generates a new, generic resolver definition in the given or default project.
674 */
675export interface AngularResolverOptionsSchema {
676 /**
677 * When true (the default), creates the new files at the top level of the current project.
678 */
679 flat?: boolean;
680 /**
681 * The name of the new resolver.
682 */
683 name: string;
684 /**
685 * The path at which to create the interface that defines the resolver, relative to the
686 * current workspace.
687 */
688 path?: string;
689 /**
690 * The name of the project.
691 */
692 project?: string;
693 /**
694 * Do not create "spec.ts" test files for the new resolver.
695 */
696 skipTests?: boolean;
697}
698/**
699 * Creates a new, generic service definition in the given or default project.
700 */
701export interface AngularServiceOptionsSchema {
702 /**
703 * When true (the default), creates files at the top level of the project.
704 */
705 flat?: boolean;
706 /**
707 * Apply lint fixes after generating the service.
708 * @deprecated Use "ng lint --fix" directly instead.
709 */
710 lintFix?: boolean;
711 /**
712 * The name of the service.
713 */
714 name: string;
715 /**
716 * The path at which to create the service, relative to the workspace root.
717 */
718 path?: string;
719 /**
720 * The name of the project.
721 */
722 project?: string;
723 /**
724 * Do not create "spec.ts" test files for the new service.
725 */
726 skipTests?: boolean;
727}
728/**
729 * Creates a new, generic web worker definition in the given or default project.
730 */
731export interface AngularWebWorkerOptionsSchema {
732 /**
733 * The name of the worker.
734 */
735 name: string;
736 /**
737 * The path at which to create the worker file, relative to the current workspace.
738 */
739 path?: string;
740 /**
741 * The name of the project.
742 */
743 project: string;
744 /**
745 * Add a worker creation snippet in a sibling file of the same name.
746 */
747 snippet?: boolean;
748 /**
749 * The target to apply web worker to.
750 * @deprecated No longer has an effect.
751 */
752 target?: string;
753}
Note: See TracBrowser for help on using the repository browser.