Skip to content

Commit 9bed51e

Browse files
author
nickpape-msft
committed
A bunch of changes
1 parent 2f62664 commit 9bed51e

6 files changed

Lines changed: 7 additions & 68 deletions

File tree

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -120,6 +120,8 @@ interface IExecutable {
120120

121121
export function initialize(gulp: gulp.Gulp): void;
122122

123+
export function log(...args: Array<string | Chalk.ChalkChain>): void;
124+
123125
export function logSummary(value: string): void;
124126

125127
export function mergeConfig(config: IBuildConfig): void;

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

Lines changed: 2 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,9 @@
11
export declare function addSuppression(str: string): void;
22

33
class ApiExtractorTask extends GulpTask<IApiExtractorTaskConfig> {
4-
// (undocumented)
54
executeTask(gulp: gulp.Gulp, completeCallback: (error?: string) => void): NodeJS.ReadWriteStream;
6-
// (undocumented)
75
loadSchema(): Object;
8-
// (undocumented)
96
name: string;
10-
// (undocumented)
117
taskConfig: IApiExtractorTaskConfig;
128
}
139

@@ -74,10 +70,8 @@ class GulpTask<TASK_CONFIG> implements IExecutable {
7470
taskConfig: TASK_CONFIG;
7571
}
7672

77-
// (undocumented)
7873
interface IBuildConfig {
7974
args?: {
80-
// (undocumented)
8175
[ name: string ]: string | boolean;
8276
}
8377
buildErrorIconPath?: string;
@@ -92,7 +86,6 @@ interface IBuildConfig {
9286
packageFolder?: string;
9387
production?: boolean;
9488
properties?: {
95-
// (undocumented)
9689
[ key: string ]: any;
9790
}
9891
relogIssues?: boolean;
@@ -107,18 +100,15 @@ interface IBuildConfig {
107100

108101
interface ICopyConfig {
109102
copyTo: {
110-
// (undocumented)
111103
[ destPath: string ]: string[];
112104
}
113105
shouldFlatten?: boolean;
114106
}
115107

116108
interface ICustomGulpTask {
117-
// (undocumented)
118109
(gulp: gulp.Gulp | GulpProxy, buildConfig: IBuildConfig, done: (failure?: Object) => void): Promise<Object> | NodeJS.ReadWriteStream | void;
119110
}
120111

121-
// (undocumented)
122112
interface IExecutable {
123113
execute: (config: IBuildConfig) => Promise<void>;
124114
getCleanMatch?: (config: IBuildConfig, taskConfig?: any) => string[];
@@ -129,12 +119,12 @@ interface IExecutable {
129119

130120
export declare function initialize(gulp: gulp.Gulp): void;
131121

132-
// (undocumented)
133122
interface ITsConfigFile<T> {
134-
// (undocumented)
135123
compilerOptions: T;
136124
}
137125

126+
export declare function log(...args: Array<string | Chalk.ChalkChain>): void;
127+
138128
export declare function logSummary(value: string): void;
139129

140130
export declare function mergeConfig(config: IBuildConfig): void;
@@ -147,10 +137,8 @@ export declare function replaceConfig(config: IBuildConfig): void;
147137
export declare function reset(): void;
148138

149139
class SchemaValidator {
150-
// (undocumented)
151140
static getFormattedErrorMessage(errors: Validator.SchemaErrorDetail[], dataFilePath?: string): string;
152141
static readAndValidateJson < TResult >(dataFilePath: string, schemaFilePath: string): TResult;
153-
// (undocumented)
154142
static readCommentedJsonFile < TResult >(filename: string): TResult;
155143
static validate(data: Object, schema: Object, dataFilePath?: string): void;
156144
}
@@ -164,37 +152,25 @@ export declare function subTask(taskName: string, fn: ICustomGulpTask): IExecuta
164152
export declare function task(taskName: string, task: IExecutable): IExecutable;
165153

166154
enum TestResultState {
167-
// (undocumented)
168155
Failed = 1,
169-
// (undocumented)
170156
FlakyFailed = 2,
171-
// (undocumented)
172157
Passed = 0,
173-
// (undocumented)
174158
Skipped = 3
175159
}
176160

177-
// (undocumented)
178161
class TypeScriptConfiguration {
179162
static getGulpTypescriptOptions(buildConfig: IBuildConfig): ITsConfigFile<ts.Settings>;
180163
static getTypescriptCompiler(): any;
181-
// (undocumented)
182164
static getTypescriptOptions(buildConfig: IBuildConfig): ITsConfigFile<typescript.CompilerOptions>;
183165
static setTypescriptCompiler(typescript: any): void;
184166
}
185167

186-
// (undocumented)
187168
class TypeScriptTask extends GulpTask<ITypeScriptTaskConfig> {
188-
// (undocumented)
189169
executeTask(gulp: gulpType.Gulp, completeCallback: (result?: string) => void): void;
190-
// (undocumented)
191170
getCleanMatch(buildConfig: IBuildConfig, taskConfig?: ITypeScriptTaskConfig): string[];
192-
// (undocumented)
193171
loadSchema(): Object;
194172
mergeConfig(config: ITypeScriptTaskConfig): void;
195-
// (undocumented)
196173
name: string;
197-
// (undocumented)
198174
taskConfig: ITypeScriptTaskConfig;
199175
}
200176

‎common/reviews/api/package-deps-hash.api.ts‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
1-
// (undocumented)
21
export function getPackageDeps(packagePath: string = process.cwd(), excludedPaths?: string[]): IPackageDeps;
32

4-
// (undocumented)
53
interface IPackageDeps {
6-
// (undocumented)
74
files: {
8-
// (undocumented)
95
[ key: string ]: string
106
}
117
}

‎common/reviews/api/test-web-library-build.api.ts‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
1-
// (undocumented)
21
export function add(num1: number, num2: number): number;
32

4-
// (undocumented)
53
export function log(message: string): void;
64

7-
// (undocumented)
85
export function logClass(): void;
96

107
// (No packageDescription for this package)

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

Lines changed: 2 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,9 @@
11
export declare function addSuppression(str: string): void;
22

33
class ApiExtractorTask extends GulpTask<IApiExtractorTaskConfig> {
4-
// (undocumented)
54
executeTask(gulp: gulp.Gulp, completeCallback: (error?: string) => void): NodeJS.ReadWriteStream;
6-
// (undocumented)
75
loadSchema(): Object;
8-
// (undocumented)
96
name: string;
10-
// (undocumented)
117
taskConfig: IApiExtractorTaskConfig;
128
}
139

@@ -74,10 +70,8 @@ class GulpTask<TASK_CONFIG> implements IExecutable {
7470
taskConfig: TASK_CONFIG;
7571
}
7672

77-
// (undocumented)
7873
interface IBuildConfig {
7974
args?: {
80-
// (undocumented)
8175
[ name: string ]: string | boolean;
8276
}
8377
buildErrorIconPath?: string;
@@ -92,7 +86,6 @@ interface IBuildConfig {
9286
packageFolder?: string;
9387
production?: boolean;
9488
properties?: {
95-
// (undocumented)
9689
[ key: string ]: any;
9790
}
9891
relogIssues?: boolean;
@@ -107,18 +100,15 @@ interface IBuildConfig {
107100

108101
interface ICopyConfig {
109102
copyTo: {
110-
// (undocumented)
111103
[ destPath: string ]: string[];
112104
}
113105
shouldFlatten?: boolean;
114106
}
115107

116108
interface ICustomGulpTask {
117-
// (undocumented)
118109
(gulp: gulp.Gulp | GulpProxy, buildConfig: IBuildConfig, done: (failure?: Object) => void): Promise<Object> | NodeJS.ReadWriteStream | void;
119110
}
120111

121-
// (undocumented)
122112
interface IExecutable {
123113
execute: (config: IBuildConfig) => Promise<void>;
124114
getCleanMatch?: (config: IBuildConfig, taskConfig?: any) => string[];
@@ -129,20 +119,19 @@ interface IExecutable {
129119

130120
export declare function initialize(gulp: gulp.Gulp): void;
131121

132-
// (undocumented)
133122
interface ITsConfigFile<T> {
134-
// (undocumented)
135123
compilerOptions: T;
136124
}
137125

138-
// (undocumented)
139126
interface IWebpackTaskConfig {
140127
config?: Webpack.Configuration;
141128
configPath: string;
142129
suppressWarnings?: (string | RegExp)[];
143130
webpack?: typeof Webpack;
144131
}
145132

133+
export declare function log(...args: Array<string | Chalk.ChalkChain>): void;
134+
146135
export declare function logSummary(value: string): void;
147136

148137
export declare function mergeConfig(config: IBuildConfig): void;
@@ -155,10 +144,8 @@ export declare function replaceConfig(config: IBuildConfig): void;
155144
export declare function reset(): void;
156145

157146
class SchemaValidator {
158-
// (undocumented)
159147
static getFormattedErrorMessage(errors: Validator.SchemaErrorDetail[], dataFilePath?: string): string;
160148
static readAndValidateJson < TResult >(dataFilePath: string, schemaFilePath: string): TResult;
161-
// (undocumented)
162149
static readCommentedJsonFile < TResult >(filename: string): TResult;
163150
static validate(data: Object, schema: Object, dataFilePath?: string): void;
164151
}
@@ -172,37 +159,25 @@ export declare function subTask(taskName: string, fn: ICustomGulpTask): IExecuta
172159
export declare function task(taskName: string, task: IExecutable): IExecutable;
173160

174161
enum TestResultState {
175-
// (undocumented)
176162
Failed = 1,
177-
// (undocumented)
178163
FlakyFailed = 2,
179-
// (undocumented)
180164
Passed = 0,
181-
// (undocumented)
182165
Skipped = 3
183166
}
184167

185-
// (undocumented)
186168
class TypeScriptConfiguration {
187169
static getGulpTypescriptOptions(buildConfig: IBuildConfig): ITsConfigFile<ts.Settings>;
188170
static getTypescriptCompiler(): any;
189-
// (undocumented)
190171
static getTypescriptOptions(buildConfig: IBuildConfig): ITsConfigFile<typescript.CompilerOptions>;
191172
static setTypescriptCompiler(typescript: any): void;
192173
}
193174

194-
// (undocumented)
195175
class TypeScriptTask extends GulpTask<ITypeScriptTaskConfig> {
196-
// (undocumented)
197176
executeTask(gulp: gulpType.Gulp, completeCallback: (result?: string) => void): void;
198-
// (undocumented)
199177
getCleanMatch(buildConfig: IBuildConfig, taskConfig?: ITypeScriptTaskConfig): string[];
200-
// (undocumented)
201178
loadSchema(): Object;
202179
mergeConfig(config: ITypeScriptTaskConfig): void;
203-
// (undocumented)
204180
name: string;
205-
// (undocumented)
206181
taskConfig: ITypeScriptTaskConfig;
207182
}
208183

@@ -217,19 +192,12 @@ export declare function warn(...args: Array<string | Chalk.ChalkChain>): void;
217192

218193
export declare function watch(watchMatch: string | string[], task: IExecutable): IExecutable;
219194

220-
// (undocumented)
221195
class WebpackTask extends GulpTask<IWebpackTaskConfig> {
222-
// (undocumented)
223196
executeTask(gulp: gulp.Gulp, completeCallback: (result?: Object) => void): void;
224-
// (undocumented)
225197
isEnabled(buildConfig: IBuildConfig): boolean;
226-
// (undocumented)
227198
loadSchema(): Object;
228-
// (undocumented)
229199
name: string;
230-
// (undocumented)
231200
resources: Object;
232-
// (undocumented)
233201
taskConfig: IWebpackTaskConfig;
234202
}
235203

‎gulp-core-build/src/logging.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -346,7 +346,7 @@ export function logSummary(value: string): void {
346346

347347
/**
348348
* Log a message to the console
349-
* @param args... - the messages to log to the console
349+
* @param args - the messages to log to the console
350350
*/
351351
export function log(...args: Array<string | Chalk.ChalkChain>): void {
352352
'use strict';

0 commit comments

Comments
 (0)