Skip to content

Commit 547c0f7

Browse files
author
nickpape-msft
committed
Convert let to const. Run API-Lint
1 parent eccd81e commit 547c0f7

33 files changed

Lines changed: 1019 additions & 66 deletions

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
// WARNING: Unsupported export: karma
2+
// WARNING: Unsupported export: default

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
// WARNING: Unsupported export: instrument
2+
// WARNING: Unsupported export: mocha
3+
// WARNING: Unsupported export: default

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
// WARNING: Unsupported export: sass
2+
// WARNING: Unsupported export: default

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
// WARNING: Unsupported export: serve
2+
// WARNING: Unsupported export: reload
3+
// WARNING: Unsupported export: trustDevCert
4+
// WARNING: Unsupported export: untrustDevCert
5+
// WARNING: Unsupported export: default

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

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
class ApiExtractorTask extends GulpTask<IApiExtractorTaskConfig> {
2+
// (undocumented)
3+
public executeTask(gulp: gulp.Gulp, completeCallback: (error?: string) => void): NodeJS.ReadWriteStream;
4+
// (undocumented)
5+
public loadSchema(): Object;
6+
// (undocumented)
7+
public name: string;
8+
// (undocumented)
9+
public taskConfig: IApiExtractorTaskConfig;
10+
}
11+
12+
// (undocumented)
13+
class TypeScriptTask extends GulpTask<ITypeScriptTaskConfig> {
14+
// (undocumented)
15+
public executeTask(gulp: gulpType.Gulp, completeCallback: (result?: string) => void): void;
16+
// (undocumented)
17+
public getCleanMatch(buildConfig: IBuildConfig, taskConfig: ITypeScriptTaskConfig = this.taskConfig): string[];
18+
public mergeConfig(config: ITypeScriptTaskConfig): void;
19+
// (undocumented)
20+
public name: string;
21+
// (undocumented)
22+
public taskConfig: ITypeScriptTaskConfig;
23+
}
24+
25+
// WARNING: Unsupported export: apiExtractor
26+
// WARNING: Unsupported export: typescript
27+
// WARNING: Unsupported export: tslint
28+
// WARNING: Unsupported export: text
29+
// WARNING: Unsupported export: removeTripleSlash
30+
// WARNING: Unsupported export: default

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

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
// (undocumented)
2+
interface IWebpackTaskConfig {
3+
config?: Webpack.Configuration;
4+
configPath: string;
5+
suppressWarnings?: (string | RegExp)[];
6+
}
7+
8+
// (undocumented)
9+
class WebpackTask extends GulpTask<IWebpackTaskConfig> {
10+
// (undocumented)
11+
public executeTask(gulp: gulp.Gulp, completeCallback: (result?: Object) => void): void;
12+
// (undocumented)
13+
public isEnabled(buildConfig: IBuildConfig): boolean;
14+
// (undocumented)
15+
public name: string;
16+
// (undocumented)
17+
public readonly resources: Object;
18+
// (undocumented)
19+
public taskConfig: IWebpackTaskConfig;
20+
}
21+
22+
// WARNING: Unsupported export: webpack
23+
// WARNING: Unsupported export: default

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

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

0 commit comments

Comments
 (0)