UNPKG

4.47 kBTypeScriptView Raw
1/**
2 * Karma target options for Build Facade.
3 */
4export interface Schema {
5 /**
6 * List of static application assets.
7 */
8 assets?: AssetPattern[];
9 /**
10 * Override which browsers tests are run against.
11 */
12 browsers?: string;
13 /**
14 * Output a code coverage report.
15 */
16 codeCoverage?: boolean;
17 /**
18 * Globs to exclude from code coverage.
19 */
20 codeCoverageExclude?: string[];
21 /**
22 * Replace compilation source files with other compilation source files in the build.
23 */
24 fileReplacements?: FileReplacement[];
25 /**
26 * Globs of files to include, relative to workspace or project root.
27 * There are 2 special cases:
28 * - when a path to directory is provided, all spec files ending ".spec.@(ts|tsx)" will be
29 * included
30 * - when a path to a file is provided, and a matching spec file exists it will be included
31 * instead
32 */
33 include?: string[];
34 /**
35 * The stylesheet language to use for the application's inline component styles.
36 */
37 inlineStyleLanguage?: InlineStyleLanguage;
38 /**
39 * The name of the Karma configuration file.
40 */
41 karmaConfig: string;
42 /**
43 * The name of the main entry-point file.
44 */
45 main: string;
46 /**
47 * Enable and define the file watching poll time period in milliseconds.
48 */
49 poll?: number;
50 /**
51 * The name of the polyfills file.
52 */
53 polyfills?: string;
54 /**
55 * Do not use the real path when resolving modules. If unset then will default to `true` if
56 * NodeJS option --preserve-symlinks is set.
57 */
58 preserveSymlinks?: boolean;
59 /**
60 * Log progress to the console while building.
61 */
62 progress?: boolean;
63 /**
64 * Karma reporters to use. Directly passed to the karma runner.
65 */
66 reporters?: string[];
67 /**
68 * Global scripts to be included in the build.
69 */
70 scripts?: ExtraEntryPoint[];
71 /**
72 * Output source maps for scripts and styles. For more information, see
73 * https://angular.io/guide/workspace-config#source-map-configuration.
74 */
75 sourceMap?: SourceMapUnion;
76 /**
77 * Options to pass to style preprocessors
78 */
79 stylePreprocessorOptions?: StylePreprocessorOptions;
80 /**
81 * Global styles to be included in the build.
82 */
83 styles?: ExtraEntryPoint[];
84 /**
85 * The name of the TypeScript configuration file.
86 */
87 tsConfig: string;
88 /**
89 * Run build when files change.
90 */
91 watch?: boolean;
92 /**
93 * TypeScript configuration for Web Worker modules.
94 */
95 webWorkerTsConfig?: string;
96}
97export declare type AssetPattern = AssetPatternClass | string;
98export interface AssetPatternClass {
99 /**
100 * The pattern to match.
101 */
102 glob: string;
103 /**
104 * An array of globs to ignore.
105 */
106 ignore?: string[];
107 /**
108 * The input directory path in which to apply 'glob'. Defaults to the project root.
109 */
110 input: string;
111 /**
112 * Absolute path within the output.
113 */
114 output: string;
115}
116export interface FileReplacement {
117 replace?: string;
118 replaceWith?: string;
119 src?: string;
120 with?: string;
121}
122/**
123 * The stylesheet language to use for the application's inline component styles.
124 */
125export declare enum InlineStyleLanguage {
126 Css = "css",
127 Less = "less",
128 Sass = "sass",
129 Scss = "scss"
130}
131export declare type ExtraEntryPoint = ExtraEntryPointClass | string;
132export interface ExtraEntryPointClass {
133 /**
134 * The bundle name for this extra entry point.
135 */
136 bundleName?: string;
137 /**
138 * If the bundle will be referenced in the HTML file.
139 */
140 inject?: boolean;
141 /**
142 * The file to include.
143 */
144 input: string;
145}
146/**
147 * Output source maps for scripts and styles. For more information, see
148 * https://angular.io/guide/workspace-config#source-map-configuration.
149 */
150export declare type SourceMapUnion = boolean | SourceMapClass;
151export interface SourceMapClass {
152 /**
153 * Output source maps for all scripts.
154 */
155 scripts?: boolean;
156 /**
157 * Output source maps for all styles.
158 */
159 styles?: boolean;
160 /**
161 * Resolve vendor packages source maps.
162 */
163 vendor?: boolean;
164}
165/**
166 * Options to pass to style preprocessors
167 */
168export interface StylePreprocessorOptions {
169 /**
170 * Paths to include. Paths will be resolved to workspace root.
171 */
172 includePaths?: string[];
173}