Skip to content

Commit daae774

Browse files
iclantoniclanton
committed
Code cleanup and fixing an ambiguity in the GCB API.
1 parent 788e12e commit daae774

File tree

10 files changed

+28
-25
lines changed

10 files changed

+28
-25
lines changed

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ export function addSuppression(str: string): void;
55
class CleanTask extends GulpTask<void> {
66
constructor();
77
public executeTask(gulp: gulp.Gulp,
8-
completeCallback: (error?: string) => void): void;
8+
completeCallback: (error?: string | Error) => void): void;
99
}
1010

1111
// @public
1212
class CopyTask extends GulpTask<ICopyConfig> {
1313
constructor();
1414
public executeTask(gulp: gulp.Gulp,
15-
completeCallback: (error?: string) => void): Promise<Object> | NodeJS.ReadWriteStream | void;
15+
completeCallback: (error?: string | Error) => void): Promise<Object> | NodeJS.ReadWriteStream | void;
1616
public loadSchema(): Object;
1717
}
1818

@@ -38,7 +38,7 @@ export function functionalTestRun(name: string, result: TestResultState, duratio
3838
class GenerateShrinkwrapTask extends GulpTask<void> {
3939
constructor();
4040
public executeTask(gulp: gulpType.Gulp,
41-
completeCallback: (error?: string) => void): NodeJS.ReadWriteStream | void;
41+
completeCallback: (error?: string | Error) => void): NodeJS.ReadWriteStream | void;
4242
}
4343

4444
// @public
@@ -60,7 +60,7 @@ class GulpTask<TASK_CONFIG> implements IExecutable {
6060
public execute(config: IBuildConfig): Promise<void>;
6161
// WARNING: The type "GulpProxy" needs to be exported by the package (e.g. added to index.ts)
6262
public abstract executeTask(gulp: gulp.Gulp | GulpProxy,
63-
completeCallback?: (error?: string) => void): Promise<Object> | NodeJS.ReadWriteStream | void;
63+
completeCallback?: (error?: string | Error) => void): Promise<Object> | NodeJS.ReadWriteStream | void;
6464
public fileError(filePath: string, line: number, column: number, errorCode: string, message: string): void;
6565
public fileExists(localPath: string): boolean;
6666
public fileWarning(filePath: string, line: number, column: number, warningCode: string, message: string): void;

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ class ApiExtractorTask extends GulpTask<IApiExtractorTaskConfig> {
1616
// @public
1717
class CleanTask extends GulpTask<void> {
1818
constructor();
19-
executeTask(gulp: gulp.Gulp, completeCallback: (error?: string) => void): void;
19+
executeTask(gulp: gulp.Gulp, completeCallback: (error?: string | Error) => void): void;
2020
}
2121

2222
// @public
2323
class CopyTask extends GulpTask<ICopyConfig> {
2424
constructor();
25-
executeTask(gulp: gulp.Gulp, completeCallback: (error?: string) => void): Promise<Object> | NodeJS.ReadWriteStream | void;
25+
executeTask(gulp: gulp.Gulp, completeCallback: (error?: string | Error) => void): Promise<Object> | NodeJS.ReadWriteStream | void;
2626
loadSchema(): Object;
2727
}
2828

@@ -47,7 +47,7 @@ export declare function functionalTestRun(name: string, result: TestResultState,
4747
// @public
4848
class GenerateShrinkwrapTask extends GulpTask<void> {
4949
constructor();
50-
executeTask(gulp: gulpType.Gulp, completeCallback: (error?: string) => void): NodeJS.ReadWriteStream | void;
50+
executeTask(gulp: gulpType.Gulp, completeCallback: (error?: string | Error) => void): NodeJS.ReadWriteStream | void;
5151
}
5252

5353
// @public
@@ -67,7 +67,7 @@ class GulpTask<TASK_CONFIG> implements IExecutable {
6767
copyFile(localSourcePath: string, localDestPath?: string): void;
6868
enabled: boolean;
6969
execute(config: IBuildConfig): Promise<void>;
70-
abstract executeTask(gulp: gulp.Gulp | GulpProxy, completeCallback?: (error?: string) => void): Promise<Object> | NodeJS.ReadWriteStream | void;
70+
abstract executeTask(gulp: gulp.Gulp | GulpProxy, completeCallback?: (error?: string | Error) => void): Promise<Object> | NodeJS.ReadWriteStream | void;
7171
fileError(filePath: string, line: number, column: number, errorCode: string, message: string): void;
7272
fileExists(localPath: string): boolean;
7373
fileWarning(filePath: string, line: number, column: number, warningCode: string, message: string): void;

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,13 @@ class ApiExtractorTask extends GulpTask<IApiExtractorTaskConfig> {
1616
// @public
1717
class CleanTask extends GulpTask<void> {
1818
constructor();
19-
executeTask(gulp: gulp.Gulp, completeCallback: (error?: string) => void): void;
19+
executeTask(gulp: gulp.Gulp, completeCallback: (error?: string | Error) => void): void;
2020
}
2121

2222
// @public
2323
class CopyTask extends GulpTask<ICopyConfig> {
2424
constructor();
25-
executeTask(gulp: gulp.Gulp, completeCallback: (error?: string) => void): Promise<Object> | NodeJS.ReadWriteStream | void;
25+
executeTask(gulp: gulp.Gulp, completeCallback: (error?: string | Error) => void): Promise<Object> | NodeJS.ReadWriteStream | void;
2626
loadSchema(): Object;
2727
}
2828

@@ -47,7 +47,7 @@ export declare function functionalTestRun(name: string, result: TestResultState,
4747
// @public
4848
class GenerateShrinkwrapTask extends GulpTask<void> {
4949
constructor();
50-
executeTask(gulp: gulpType.Gulp, completeCallback: (error?: string) => void): NodeJS.ReadWriteStream | void;
50+
executeTask(gulp: gulpType.Gulp, completeCallback: (error?: string | Error) => void): NodeJS.ReadWriteStream | void;
5151
}
5252

5353
// @public
@@ -67,7 +67,7 @@ class GulpTask<TASK_CONFIG> implements IExecutable {
6767
copyFile(localSourcePath: string, localDestPath?: string): void;
6868
enabled: boolean;
6969
execute(config: IBuildConfig): Promise<void>;
70-
abstract executeTask(gulp: gulp.Gulp | GulpProxy, completeCallback?: (error?: string) => void): Promise<Object> | NodeJS.ReadWriteStream | void;
70+
abstract executeTask(gulp: gulp.Gulp | GulpProxy, completeCallback?: (error?: string | Error) => void): Promise<Object> | NodeJS.ReadWriteStream | void;
7171
fileError(filePath: string, line: number, column: number, errorCode: string, message: string): void;
7272
fileExists(localPath: string): boolean;
7373
fileWarning(filePath: string, line: number, column: number, warningCode: string, message: string): void;

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -154,7 +154,7 @@ class CustomTask extends GulpTask<void> {
154154
this._fn = fn.bind(this);
155155
}
156156

157-
public executeTask(gulp: gulp.Gulp | GulpProxy, completeCallback?: (error?: string) => void):
157+
public executeTask(gulp: gulp.Gulp | GulpProxy, completeCallback?: (error?: string | Error) => void):
158158
Promise<Object> | NodeJS.ReadWriteStream | void {
159159
return this._fn(gulp, getConfig(), completeCallback);
160160
}

‎core-build/gulp-core-build/src/tasks/BuildReceiptTask.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export class CheckBuildReceiptTask extends GulpTask<IBuildReceiptTask> {
3232
public name: string = 'check-for-changes';
3333
public executeTask(
3434
gulp: gulp.Gulp,
35-
completeCallback: (error?: string) => void
35+
completeCallback: (error?: string | Error) => void
3636
): Promise<Object> | NodeJS.ReadWriteStream | void {
3737
_getLocalHashes().then(localHashes => {
3838
_lastLocalHashes = localHashes;
@@ -61,7 +61,7 @@ export class UpdateBuildReceiptTask extends GulpTask<IBuildReceiptTask> {
6161
public name: string = 'mark-changes';
6262
public executeTask(
6363
gulp: gulp.Gulp,
64-
completeCallback: (error?: string) => void
64+
completeCallback: (error?: string | Error) => void
6565
): Promise<Object> | NodeJS.ReadWriteStream | void {
6666

6767
const packageHashPath: string = path.join(process.cwd(), this.buildConfig.packageFolder, 'build.json');

‎core-build/gulp-core-build/src/tasks/CleanTask.ts‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,16 +28,19 @@ export class CleanTask extends GulpTask<void> {
2828
*/
2929
public executeTask(
3030
gulp: gulp.Gulp,
31-
completeCallback: (error?: string) => void
31+
completeCallback: (error?: string | Error) => void
3232
): void {
3333
const { distFolder, libFolder, libAMDFolder, tempFolder }: IBuildConfig = this.buildConfig;
34-
let cleanPaths: (string | undefined)[] = [
34+
let cleanPaths: string[] = [
3535
distFolder,
36-
libAMDFolder,
3736
libFolder,
3837
tempFolder
3938
];
4039

40+
if (libAMDFolder) {
41+
cleanPaths.push(libAMDFolder);
42+
}
43+
4144
// Give each registered task an opportunity to add their own clean paths.
4245
for (const executable of this.buildConfig.uniqueTasks || []) {
4346
if (executable.getCleanMatch) {
@@ -64,7 +67,7 @@ export class CleanTask extends GulpTask<void> {
6467
}
6568

6669
try {
67-
FileDeletionUtility.deletePatterns(cleanPaths.filter((cleanPath: string | undefined) => !!cleanPath) as string[]);
70+
FileDeletionUtility.deletePatterns(cleanPaths);
6871
completeCallback();
6972
} catch (e) {
7073
completeCallback(e);

‎core-build/gulp-core-build/src/tasks/CopyTask.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ export class CopyTask extends GulpTask<ICopyConfig> {
5757
*/
5858
public executeTask(
5959
gulp: gulp.Gulp,
60-
completeCallback: (error?: string) => void
60+
completeCallback: (error?: string | Error) => void
6161
): Promise<Object> | NodeJS.ReadWriteStream | void {
6262
/* tslint:disable:typedef */
6363
const flatten = require('gulp-flatten');

‎core-build/gulp-core-build/src/tasks/GenerateShrinkwrapTask.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export class GenerateShrinkwrapTask extends GulpTask<void> {
2828
*/
2929
public executeTask(
3030
gulp: gulpType.Gulp,
31-
completeCallback: (error?: string) => void
31+
completeCallback: (error?: string | Error) => void
3232
): NodeJS.ReadWriteStream | void {
3333
const pathToShrinkwrap: string = path.join(this.buildConfig.rootPath, 'npm-shrinkwrap.json');
3434

‎core-build/gulp-core-build/src/tasks/GulpTask.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ export abstract class GulpTask<TASK_CONFIG> implements IExecutable {
137137
*/
138138
public abstract executeTask(
139139
gulp: gulp.Gulp | GulpProxy,
140-
completeCallback?: (error?: string) => void
140+
completeCallback?: (error?: string | Error) => void
141141
): Promise<Object> | NodeJS.ReadWriteStream | void;
142142

143143
/**
@@ -231,7 +231,7 @@ export abstract class GulpTask<TASK_CONFIG> implements IExecutable {
231231
throw new Error('The task subclass is missing the "executeTask" method.');
232232
}
233233

234-
stream = this.executeTask(this.buildConfig.gulp, (error?: string) => {
234+
stream = this.executeTask(this.buildConfig.gulp, (error?: string | Error) => {
235235
if (!error) {
236236
resolve();
237237
} else if (typeof error === 'string') {

‎core-build/gulp-core-build/src/tests/GulpTask.test.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ class CallbackTask extends GulpTask<IConfig> {
9999
public taskConfig: IConfig = {
100100
};
101101

102-
public executeTask(gulp: gulp.Gulp, callback: (error?: string) => void): void {
102+
public executeTask(gulp: gulp.Gulp, callback: (error?: string | Error) => void): void {
103103
testArray.push(this.name);
104104
callback();
105105
}
@@ -116,7 +116,7 @@ class SchemaTask extends GulpTask<ISimpleConfig> {
116116
shouldDoThings: false
117117
};
118118

119-
public executeTask(gulp: gulp.Gulp, callback: (error?: string) => void): void {
119+
public executeTask(gulp: gulp.Gulp, callback: (error?: string | Error) => void): void {
120120
callback();
121121
}
122122

0 commit comments

Comments
 (0)