Skip to content

Commit efc7d98

Browse files
author
nickpape-msft
committed
Generate
1 parent 634f763 commit efc7d98

6 files changed

Lines changed: 137 additions & 282 deletions

‎common/npm-shrinkwrap.json‎

Lines changed: 6 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎common/reviews/api/gulp-core-build-typescript.api.ts‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,21 @@ class ApiExtractorTask extends GulpTask<IApiExtractorTaskConfig> {
99
public taskConfig: IApiExtractorTaskConfig;
1010
}
1111

12+
// (undocumented)
13+
interface ITsConfigFile<T> {
14+
// (undocumented)
15+
compilerOptions: T;
16+
}
17+
18+
// (undocumented)
19+
class TypeScriptConfiguration {
20+
public static getGulpTypescriptOptions(buildConfig: IBuildConfig): ITsConfigFile<ts.Settings>;
21+
public static getTypescriptCompiler(): any;
22+
// (undocumented)
23+
public static getTypescriptOptions(buildConfig: IBuildConfig): ITsConfigFile<typescript.CompilerOptions>;
24+
public static setTypescriptCompiler(typescript: any): void;
25+
}
26+
1227
// (undocumented)
1328
class TypeScriptTask extends GulpTask<ITypeScriptTaskConfig> {
1429
// (undocumented)

‎common/reviews/api/gulp-core-build-webpack.api.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ interface IWebpackTaskConfig {
33
config?: Webpack.Configuration;
44
configPath: string;
55
suppressWarnings?: (string | RegExp)[];
6+
webpack?: typeof Webpack;
67
}
78

89
// (undocumented)

‎common/reviews/api/gulp-core-build.api.ts‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -176,6 +176,16 @@ interface IExecutable {
176176

177177
export function initialize(gulp: gulp.Gulp): void;
178178

179+
// (undocumented)
180+
interface ISchemaValidatorResult {
181+
// (undocumented)
182+
details?: ZSchema.SchemaError[];
183+
// (undocumented)
184+
message?: string;
185+
// (undocumented)
186+
name?: string;
187+
}
188+
179189
// (undocumented)
180190
export function log(...args: Array<string | Chalk.ChalkChain>): void;
181191

@@ -200,6 +210,15 @@ export function replaceConfig(config: IBuildConfig): void;
200210
// (undocumented)
201211
export function reset(): void;
202212

213+
class SchemaValidator {
214+
// (undocumented)
215+
public static getFormattedErrorMessage(error: ISchemaValidatorResult, dataFilePath?: string): string;
216+
public static readAndValidateJson < TResult >(dataFilePath: string, schemaFilePath: string): TResult;
217+
// (undocumented)
218+
public static readCommentedJsonFile < TResult >(filename: string): TResult;
219+
public static validate(data: Object, schema: Object, dataFilePath?: string): void;
220+
}
221+
203222
export function serial(...tasks: Array<IExecutable[] | IExecutable>): IExecutable;
204223

205224
export function setConfig(config: IBuildConfig): void;

‎common/reviews/api/node-library-build.api.ts‎

Lines changed: 0 additions & 276 deletions
Original file line numberDiff line numberDiff line change
@@ -1,279 +1,3 @@
1-
// (undocumented)
2-
export declare function addSuppression(str: string): void;
3-
4-
class ApiExtractorTask extends GulpTask<IApiExtractorTaskConfig> {
5-
// (undocumented)
6-
executeTask(gulp: gulp.Gulp, completeCallback: (error?: string) => void): NodeJS.ReadWriteStream;
7-
// (undocumented)
8-
loadSchema(): Object;
9-
// (undocumented)
10-
name: string;
11-
// (undocumented)
12-
taskConfig: IApiExtractorTaskConfig;
13-
}
14-
15-
// (undocumented)
16-
class CleanTask extends GulpTask<ICleanConfig> {
17-
// (undocumented)
18-
executeTask(gulp: gulp.Gulp, completeCallback: (result?: Object) => void): void;
19-
// (undocumented)
20-
name: string;
21-
// (undocumented)
22-
taskConfig: ICleanConfig;
23-
}
24-
25-
class CopyTask extends GulpTask<ICopyConfig> {
26-
// (undocumented)
27-
executeTask(gulp: gulp.Gulp, completeCallback: (result?: Object) => void): Promise<Object> | NodeJS.ReadWriteStream | void;
28-
// (undocumented)
29-
loadSchema(): Object;
30-
// (undocumented)
31-
taskConfig: ICopyConfig;
32-
}
33-
34-
// (undocumented)
35-
export declare function coverageData(coverage: number, threshold: number, filePath: string): void;
36-
37-
// (undocumented)
38-
export declare function endTaskSrc(taskName: string, startHrtime: [number, number], fileCount: number): void;
39-
40-
// (undocumented)
41-
export declare function error(...args: Array<string | Chalk.ChalkChain>): void;
42-
43-
// (undocumented)
44-
export declare function fileError(taskName: string, filePath: string, line: number, column: number, errorCode: string, message: string): void;
45-
46-
// (undocumented)
47-
export declare function fileLog(write: (text: string) => void, taskName: string, filePath: string, line: number, column: number, errorCode: string, message: string): void;
48-
49-
// (undocumented)
50-
export declare function fileWarning(taskName: string, filePath: string, line: number, column: number, errorCode: string, message: string): void;
51-
52-
// (undocumented)
53-
export declare function functionalTestRun(name: string, result: TestResultState, duration: number): void;
54-
55-
// (undocumented)
56-
export declare function generateGulpError(error: Object): Object;
57-
58-
class GenerateShrinkwrapTask extends GulpTask<{}> {
59-
// (undocumented)
60-
executeTask(gulp: gulpType.Gulp): NodeJS.ReadWriteStream;
61-
// (undocumented)
62-
name: string;
63-
}
64-
65-
export declare function getConfig(): IBuildConfig;
66-
67-
// (undocumented)
68-
export declare function getErrors(): string[];
69-
70-
// (undocumented)
71-
export declare function getStart(): [number, number];
72-
73-
// (undocumented)
74-
export declare function getWarnings(): string[];
75-
76-
// (undocumented)
77-
export declare function getWatchMode(): boolean;
78-
79-
// (undocumented)
80-
class GulpTask<TASK_CONFIG> implements IExecutable {
81-
protected _getConfigFilePath(): string;
82-
protected _readCommentedJsonFile(filename: string): TASK_CONFIG;
83-
// (undocumented)
84-
buildConfig: IBuildConfig;
85-
// (undocumented)
86-
cleanMatch: string[];
87-
// (undocumented)
88-
copyFile(localSourcePath: string, localDestPath?: string): void;
89-
// (undocumented)
90-
execute(config: IBuildConfig): Promise<void>;
91-
// (undocumented)
92-
abstract executeTask(gulp: gulp.Gulp | GulpProxy, completeCallback?: (result?: Object) => void): Promise<Object> | NodeJS.ReadWriteStream | void;
93-
// (undocumented)
94-
fileError(filePath: string, line: number, column: number, errorCode: string, message: string): void;
95-
// (undocumented)
96-
fileExists(localPath: string): boolean;
97-
// (undocumented)
98-
fileWarning(filePath: string, line: number, column: number, errorCode: string, message: string): void;
99-
// (undocumented)
100-
getCleanMatch(buildConfig: IBuildConfig, taskConfig?: TASK_CONFIG): string[];
101-
// (undocumented)
102-
isEnabled(buildConfig: IBuildConfig): boolean;
103-
loadSchema(): Object;
104-
// (undocumented)
105-
log(message: string): void;
106-
// (undocumented)
107-
logError(message: string): void;
108-
// (undocumented)
109-
logVerbose(message: string): void;
110-
// (undocumented)
111-
logWarning(message: string): void;
112-
mergeConfig(taskConfig: TASK_CONFIG): void;
113-
// (undocumented)
114-
name: string;
115-
// (undocumented)
116-
onRegister(): void;
117-
// (undocumented)
118-
readJSONSync(localPath: string): Object;
119-
replaceConfig(taskConfig: TASK_CONFIG): void;
120-
// (undocumented)
121-
resolvePath(localPath: string): string;
122-
schema: Object;
123-
setConfig(taskConfig: TASK_CONFIG): void;
124-
// (undocumented)
125-
taskConfig: TASK_CONFIG;
126-
}
127-
128-
// (undocumented)
129-
interface IBuildConfig {
130-
args?: {
131-
// (undocumented)
132-
[ name: string ]: string | boolean;
133-
}
134-
buildErrorIconPath?: string;
135-
buildSuccessIconPath?: string;
136-
distFolder?: string;
137-
gulp?: GulpProxy | gulp.Gulp;
138-
isRedundantBuild?: boolean;
139-
libAMDFolder?: string;
140-
libFolder?: string;
141-
onTaskEnd?: (taskName: string, duration: number[], error?: any) => void;
142-
onTaskStart?: (taskName: string) => void;
143-
packageFolder?: string;
144-
production?: boolean;
145-
properties?: {
146-
// (undocumented)
147-
[ key: string ]: any;
148-
}
149-
relogIssues?: boolean;
150-
rootPath?: string;
151-
shouldWarningsFailBuild?: boolean;
152-
showToast?: boolean;
153-
srcFolder?: string;
154-
tempFolder?: string;
155-
uniqueTasks?: IExecutable[];
156-
verbose?: boolean;
157-
}
158-
159-
// (undocumented)
160-
interface ICleanConfig {
161-
}
162-
163-
// (undocumented)
164-
interface ICopyConfig {
165-
copyTo: {
166-
// (undocumented)
167-
[ destPath: string ]: string[];
168-
}
169-
shouldFlatten?: boolean;
170-
}
171-
172-
interface ICustomGulpTask {
173-
// (undocumented)
174-
(gulp: gulp.Gulp | GulpProxy, buildConfig: IBuildConfig, done: (failure?: Object) => void): Promise<Object> | NodeJS.ReadWriteStream | void;
175-
}
176-
177-
// (undocumented)
178-
interface IExecutable {
179-
execute: (config: IBuildConfig) => Promise<void>;
180-
getCleanMatch?: (config: IBuildConfig, taskConfig?: any) => string[];
181-
isEnabled?: (config?: IBuildConfig) => boolean;
182-
name?: string;
183-
onRegister?: () => void;
184-
}
185-
186-
export declare function initialize(gulp: gulp.Gulp): void;
187-
188-
// (undocumented)
189-
export declare function log(...args: Array<string | Chalk.ChalkChain>): void;
190-
191-
// (undocumented)
192-
export declare function logEndSubtask(name: string, startTime: [number, number], errorObject?: Error): void;
193-
194-
// (undocumented)
195-
export declare function logStartSubtask(name: string): void;
196-
197-
// (undocumented)
198-
export declare function logSummary(value: string): void;
199-
200-
// (undocumented)
201-
export declare function markTaskCreationTime(): void;
202-
203-
export declare function mergeConfig(config: IBuildConfig): void;
204-
205-
export declare function parallel(...tasks: Array<IExecutable[] | IExecutable>): IExecutable;
206-
207-
export declare function replaceConfig(config: IBuildConfig): void;
208-
209-
// (undocumented)
210-
export declare function reset(): void;
211-
212-
export declare function serial(...tasks: Array<IExecutable[] | IExecutable>): IExecutable;
213-
214-
export declare function setConfig(config: IBuildConfig): void;
215-
216-
// (undocumented)
217-
export declare function setExitCode(exitCode: number): void;
218-
219-
// (undocumented)
220-
export declare function setWatchMode(): void;
221-
222-
export declare function subTask(taskName: string, fn: ICustomGulpTask): IExecutable;
223-
224-
export declare function task(taskName: string, task: IExecutable): IExecutable;
225-
226-
// (undocumented)
227-
enum TestResultState {
228-
// (undocumented)
229-
Failed = 1,
230-
// (undocumented)
231-
FlakyFailed = 2,
232-
// (undocumented)
233-
Passed = 0,
234-
// (undocumented)
235-
Skipped = 3
236-
}
237-
238-
// (undocumented)
239-
class TypeScriptTask extends GulpTask<ITypeScriptTaskConfig> {
240-
// (undocumented)
241-
executeTask(gulp: gulpType.Gulp, completeCallback: (result?: string) => void): void;
242-
// (undocumented)
243-
getCleanMatch(buildConfig: IBuildConfig, taskConfig?: ITypeScriptTaskConfig): string[];
244-
mergeConfig(config: ITypeScriptTaskConfig): void;
245-
// (undocumented)
246-
name: string;
247-
// (undocumented)
248-
taskConfig: ITypeScriptTaskConfig;
249-
}
250-
251-
class ValidateShrinkwrapTask extends GulpTask<{}> {
252-
// (undocumented)
253-
executeTask(gulp: gulpType.Gulp): NodeJS.ReadWriteStream;
254-
// (undocumented)
255-
name: string;
256-
}
257-
258-
// (undocumented)
259-
export declare function verbose(...args: Array<string | Chalk.ChalkChain>): void;
260-
261-
// (undocumented)
262-
export declare function warn(...args: Array<string | Chalk.ChalkChain>): void;
263-
264-
export declare function watch(watchMatch: string | string[], task: IExecutable): IExecutable;
265-
266-
// (undocumented)
267-
export declare function writeError(e: any): void;
268-
2691
// WARNING: Unsupported export: buildTasks
2702
// WARNING: Unsupported export: testTasks
2713
// WARNING: Unsupported export: defaultTasks
272-
// WARNING: Unsupported export: clean
273-
// WARNING: Unsupported export: apiExtractor
274-
// WARNING: Unsupported export: typescript
275-
// WARNING: Unsupported export: tslint
276-
// WARNING: Unsupported export: text
277-
// WARNING: Unsupported export: removeTripleSlash
278-
// WARNING: Unsupported export: instrument
279-
// WARNING: Unsupported export: mocha

0 commit comments

Comments
 (0)