Skip to content

Commit 4a5aa47

Browse files
iclantoniclanton
committed
Fix an issue where api-extractor in GCB doesn't fail the build on API changes.
1 parent a98399b commit 4a5aa47

17 files changed

+227
-106
lines changed

‎common/reviews/api/rush-stack-compiler-2.4.api.md‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,31 +15,39 @@ import * as Typescript from 'typescript';
1515

1616
// @beta
1717
export class ApiExtractorRunner extends RushStackCompilerBase {
18-
constructor(extractorConfig: ExtractorConfig, extractorOptions: IExtractorInvokeOptions, rootPath: string, terminalProvider: ITerminalProvider);
18+
constructor(options: IRushStackCompilerBaseOptions, extractorConfig: ExtractorConfig, extractorOptions: IExtractorInvokeOptions, rootPath: string, terminalProvider: ITerminalProvider);
1919
// (undocumented)
2020
static apiExtractor: typeof ApiExtractor;
2121
// (undocumented)
2222
invoke(): Promise<void>;
2323
}
2424

2525
// @public (undocumented)
26-
export interface ITslintRunnerConfig {
27-
displayAsError?: boolean;
26+
export interface IRushStackCompilerBaseOptions {
2827
// (undocumented)
2928
fileError: WriteFileIssueFunction;
3029
// (undocumented)
3130
fileWarning: WriteFileIssueFunction;
3231
}
3332

33+
// @public (undocumented)
34+
export interface ITslintRunnerConfig extends IRushStackCompilerBaseOptions {
35+
displayAsError?: boolean;
36+
}
37+
3438
// @beta (undocumented)
35-
export interface ITypescriptCompilerOptions {
39+
export interface ITypescriptCompilerOptions extends IRushStackCompilerBaseOptions {
3640
customArgs?: string[];
3741
}
3842

3943
// @beta (undocumented)
40-
export abstract class RushStackCompilerBase<TOptions = {}> {
44+
export abstract class RushStackCompilerBase<TOptions extends IRushStackCompilerBaseOptions = IRushStackCompilerBaseOptions> {
4145
constructor(taskOptions: TOptions, rootPath: string, terminalProvider: ITerminalProvider);
4246
// (undocumented)
47+
protected _fileError: WriteFileIssueFunction;
48+
// (undocumented)
49+
protected _fileWarning: WriteFileIssueFunction;
50+
// (undocumented)
4351
protected _standardBuildFolders: StandardBuildFolders;
4452
// (undocumented)
4553
protected _taskOptions: TOptions;
@@ -93,7 +101,6 @@ export class TslintRunner extends RushStackCompilerBase<ITslintRunnerConfig> {
93101

94102
// @beta (undocumented)
95103
export class TypescriptCompiler extends RushStackCompilerBase<ITypescriptCompilerOptions> {
96-
constructor(rootPath: string, terminalProvider: ITerminalProvider);
97104
constructor(taskOptions: ITypescriptCompilerOptions, rootPath: string, terminalProvider: ITerminalProvider);
98105
// (undocumented)
99106
invoke(): Promise<void>;

‎common/reviews/api/rush-stack-compiler-2.7.api.md‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,31 +15,39 @@ import * as Typescript from 'typescript';
1515

1616
// @beta
1717
export class ApiExtractorRunner extends RushStackCompilerBase {
18-
constructor(extractorConfig: ExtractorConfig, extractorOptions: IExtractorInvokeOptions, rootPath: string, terminalProvider: ITerminalProvider);
18+
constructor(options: IRushStackCompilerBaseOptions, extractorConfig: ExtractorConfig, extractorOptions: IExtractorInvokeOptions, rootPath: string, terminalProvider: ITerminalProvider);
1919
// (undocumented)
2020
static apiExtractor: typeof ApiExtractor;
2121
// (undocumented)
2222
invoke(): Promise<void>;
2323
}
2424

2525
// @public (undocumented)
26-
export interface ITslintRunnerConfig {
27-
displayAsError?: boolean;
26+
export interface IRushStackCompilerBaseOptions {
2827
// (undocumented)
2928
fileError: WriteFileIssueFunction;
3029
// (undocumented)
3130
fileWarning: WriteFileIssueFunction;
3231
}
3332

33+
// @public (undocumented)
34+
export interface ITslintRunnerConfig extends IRushStackCompilerBaseOptions {
35+
displayAsError?: boolean;
36+
}
37+
3438
// @beta (undocumented)
35-
export interface ITypescriptCompilerOptions {
39+
export interface ITypescriptCompilerOptions extends IRushStackCompilerBaseOptions {
3640
customArgs?: string[];
3741
}
3842

3943
// @beta (undocumented)
40-
export abstract class RushStackCompilerBase<TOptions = {}> {
44+
export abstract class RushStackCompilerBase<TOptions extends IRushStackCompilerBaseOptions = IRushStackCompilerBaseOptions> {
4145
constructor(taskOptions: TOptions, rootPath: string, terminalProvider: ITerminalProvider);
4246
// (undocumented)
47+
protected _fileError: WriteFileIssueFunction;
48+
// (undocumented)
49+
protected _fileWarning: WriteFileIssueFunction;
50+
// (undocumented)
4351
protected _standardBuildFolders: StandardBuildFolders;
4452
// (undocumented)
4553
protected _taskOptions: TOptions;
@@ -93,7 +101,6 @@ export class TslintRunner extends RushStackCompilerBase<ITslintRunnerConfig> {
93101

94102
// @beta (undocumented)
95103
export class TypescriptCompiler extends RushStackCompilerBase<ITypescriptCompilerOptions> {
96-
constructor(rootPath: string, terminalProvider: ITerminalProvider);
97104
constructor(taskOptions: ITypescriptCompilerOptions, rootPath: string, terminalProvider: ITerminalProvider);
98105
// (undocumented)
99106
invoke(): Promise<void>;

‎common/reviews/api/rush-stack-compiler-2.8.api.md‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,31 +15,39 @@ import * as Typescript from 'typescript';
1515

1616
// @beta
1717
export class ApiExtractorRunner extends RushStackCompilerBase {
18-
constructor(extractorConfig: ExtractorConfig, extractorOptions: IExtractorInvokeOptions, rootPath: string, terminalProvider: ITerminalProvider);
18+
constructor(options: IRushStackCompilerBaseOptions, extractorConfig: ExtractorConfig, extractorOptions: IExtractorInvokeOptions, rootPath: string, terminalProvider: ITerminalProvider);
1919
// (undocumented)
2020
static apiExtractor: typeof ApiExtractor;
2121
// (undocumented)
2222
invoke(): Promise<void>;
2323
}
2424

2525
// @public (undocumented)
26-
export interface ITslintRunnerConfig {
27-
displayAsError?: boolean;
26+
export interface IRushStackCompilerBaseOptions {
2827
// (undocumented)
2928
fileError: WriteFileIssueFunction;
3029
// (undocumented)
3130
fileWarning: WriteFileIssueFunction;
3231
}
3332

33+
// @public (undocumented)
34+
export interface ITslintRunnerConfig extends IRushStackCompilerBaseOptions {
35+
displayAsError?: boolean;
36+
}
37+
3438
// @beta (undocumented)
35-
export interface ITypescriptCompilerOptions {
39+
export interface ITypescriptCompilerOptions extends IRushStackCompilerBaseOptions {
3640
customArgs?: string[];
3741
}
3842

3943
// @beta (undocumented)
40-
export abstract class RushStackCompilerBase<TOptions = {}> {
44+
export abstract class RushStackCompilerBase<TOptions extends IRushStackCompilerBaseOptions = IRushStackCompilerBaseOptions> {
4145
constructor(taskOptions: TOptions, rootPath: string, terminalProvider: ITerminalProvider);
4246
// (undocumented)
47+
protected _fileError: WriteFileIssueFunction;
48+
// (undocumented)
49+
protected _fileWarning: WriteFileIssueFunction;
50+
// (undocumented)
4351
protected _standardBuildFolders: StandardBuildFolders;
4452
// (undocumented)
4553
protected _taskOptions: TOptions;
@@ -93,7 +101,6 @@ export class TslintRunner extends RushStackCompilerBase<ITslintRunnerConfig> {
93101

94102
// @beta (undocumented)
95103
export class TypescriptCompiler extends RushStackCompilerBase<ITypescriptCompilerOptions> {
96-
constructor(rootPath: string, terminalProvider: ITerminalProvider);
97104
constructor(taskOptions: ITypescriptCompilerOptions, rootPath: string, terminalProvider: ITerminalProvider);
98105
// (undocumented)
99106
invoke(): Promise<void>;

‎common/reviews/api/rush-stack-compiler-2.9.api.md‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,31 +15,39 @@ import * as Typescript from 'typescript';
1515

1616
// @beta
1717
export class ApiExtractorRunner extends RushStackCompilerBase {
18-
constructor(extractorConfig: ExtractorConfig, extractorOptions: IExtractorInvokeOptions, rootPath: string, terminalProvider: ITerminalProvider);
18+
constructor(options: IRushStackCompilerBaseOptions, extractorConfig: ExtractorConfig, extractorOptions: IExtractorInvokeOptions, rootPath: string, terminalProvider: ITerminalProvider);
1919
// (undocumented)
2020
static apiExtractor: typeof ApiExtractor;
2121
// (undocumented)
2222
invoke(): Promise<void>;
2323
}
2424

2525
// @public (undocumented)
26-
export interface ITslintRunnerConfig {
27-
displayAsError?: boolean;
26+
export interface IRushStackCompilerBaseOptions {
2827
// (undocumented)
2928
fileError: WriteFileIssueFunction;
3029
// (undocumented)
3130
fileWarning: WriteFileIssueFunction;
3231
}
3332

33+
// @public (undocumented)
34+
export interface ITslintRunnerConfig extends IRushStackCompilerBaseOptions {
35+
displayAsError?: boolean;
36+
}
37+
3438
// @beta (undocumented)
35-
export interface ITypescriptCompilerOptions {
39+
export interface ITypescriptCompilerOptions extends IRushStackCompilerBaseOptions {
3640
customArgs?: string[];
3741
}
3842

3943
// @beta (undocumented)
40-
export abstract class RushStackCompilerBase<TOptions = {}> {
44+
export abstract class RushStackCompilerBase<TOptions extends IRushStackCompilerBaseOptions = IRushStackCompilerBaseOptions> {
4145
constructor(taskOptions: TOptions, rootPath: string, terminalProvider: ITerminalProvider);
4246
// (undocumented)
47+
protected _fileError: WriteFileIssueFunction;
48+
// (undocumented)
49+
protected _fileWarning: WriteFileIssueFunction;
50+
// (undocumented)
4351
protected _standardBuildFolders: StandardBuildFolders;
4452
// (undocumented)
4553
protected _taskOptions: TOptions;
@@ -93,7 +101,6 @@ export class TslintRunner extends RushStackCompilerBase<ITslintRunnerConfig> {
93101

94102
// @beta (undocumented)
95103
export class TypescriptCompiler extends RushStackCompilerBase<ITypescriptCompilerOptions> {
96-
constructor(rootPath: string, terminalProvider: ITerminalProvider);
97104
constructor(taskOptions: ITypescriptCompilerOptions, rootPath: string, terminalProvider: ITerminalProvider);
98105
// (undocumented)
99106
invoke(): Promise<void>;

‎common/reviews/api/rush-stack-compiler-3.0.api.md‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,31 +15,39 @@ import * as Typescript from 'typescript';
1515

1616
// @beta
1717
export class ApiExtractorRunner extends RushStackCompilerBase {
18-
constructor(extractorConfig: ExtractorConfig, extractorOptions: IExtractorInvokeOptions, rootPath: string, terminalProvider: ITerminalProvider);
18+
constructor(options: IRushStackCompilerBaseOptions, extractorConfig: ExtractorConfig, extractorOptions: IExtractorInvokeOptions, rootPath: string, terminalProvider: ITerminalProvider);
1919
// (undocumented)
2020
static apiExtractor: typeof ApiExtractor;
2121
// (undocumented)
2222
invoke(): Promise<void>;
2323
}
2424

2525
// @public (undocumented)
26-
export interface ITslintRunnerConfig {
27-
displayAsError?: boolean;
26+
export interface IRushStackCompilerBaseOptions {
2827
// (undocumented)
2928
fileError: WriteFileIssueFunction;
3029
// (undocumented)
3130
fileWarning: WriteFileIssueFunction;
3231
}
3332

33+
// @public (undocumented)
34+
export interface ITslintRunnerConfig extends IRushStackCompilerBaseOptions {
35+
displayAsError?: boolean;
36+
}
37+
3438
// @beta (undocumented)
35-
export interface ITypescriptCompilerOptions {
39+
export interface ITypescriptCompilerOptions extends IRushStackCompilerBaseOptions {
3640
customArgs?: string[];
3741
}
3842

3943
// @beta (undocumented)
40-
export abstract class RushStackCompilerBase<TOptions = {}> {
44+
export abstract class RushStackCompilerBase<TOptions extends IRushStackCompilerBaseOptions = IRushStackCompilerBaseOptions> {
4145
constructor(taskOptions: TOptions, rootPath: string, terminalProvider: ITerminalProvider);
4246
// (undocumented)
47+
protected _fileError: WriteFileIssueFunction;
48+
// (undocumented)
49+
protected _fileWarning: WriteFileIssueFunction;
50+
// (undocumented)
4351
protected _standardBuildFolders: StandardBuildFolders;
4452
// (undocumented)
4553
protected _taskOptions: TOptions;
@@ -93,7 +101,6 @@ export class TslintRunner extends RushStackCompilerBase<ITslintRunnerConfig> {
93101

94102
// @beta (undocumented)
95103
export class TypescriptCompiler extends RushStackCompilerBase<ITypescriptCompilerOptions> {
96-
constructor(rootPath: string, terminalProvider: ITerminalProvider);
97104
constructor(taskOptions: ITypescriptCompilerOptions, rootPath: string, terminalProvider: ITerminalProvider);
98105
// (undocumented)
99106
invoke(): Promise<void>;

‎common/reviews/api/rush-stack-compiler-3.1.api.md‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,31 +15,39 @@ import * as Typescript from 'typescript';
1515

1616
// @beta
1717
export class ApiExtractorRunner extends RushStackCompilerBase {
18-
constructor(extractorConfig: ExtractorConfig, extractorOptions: IExtractorInvokeOptions, rootPath: string, terminalProvider: ITerminalProvider);
18+
constructor(options: IRushStackCompilerBaseOptions, extractorConfig: ExtractorConfig, extractorOptions: IExtractorInvokeOptions, rootPath: string, terminalProvider: ITerminalProvider);
1919
// (undocumented)
2020
static apiExtractor: typeof ApiExtractor;
2121
// (undocumented)
2222
invoke(): Promise<void>;
2323
}
2424

2525
// @public (undocumented)
26-
export interface ITslintRunnerConfig {
27-
displayAsError?: boolean;
26+
export interface IRushStackCompilerBaseOptions {
2827
// (undocumented)
2928
fileError: WriteFileIssueFunction;
3029
// (undocumented)
3130
fileWarning: WriteFileIssueFunction;
3231
}
3332

33+
// @public (undocumented)
34+
export interface ITslintRunnerConfig extends IRushStackCompilerBaseOptions {
35+
displayAsError?: boolean;
36+
}
37+
3438
// @beta (undocumented)
35-
export interface ITypescriptCompilerOptions {
39+
export interface ITypescriptCompilerOptions extends IRushStackCompilerBaseOptions {
3640
customArgs?: string[];
3741
}
3842

3943
// @beta (undocumented)
40-
export abstract class RushStackCompilerBase<TOptions = {}> {
44+
export abstract class RushStackCompilerBase<TOptions extends IRushStackCompilerBaseOptions = IRushStackCompilerBaseOptions> {
4145
constructor(taskOptions: TOptions, rootPath: string, terminalProvider: ITerminalProvider);
4246
// (undocumented)
47+
protected _fileError: WriteFileIssueFunction;
48+
// (undocumented)
49+
protected _fileWarning: WriteFileIssueFunction;
50+
// (undocumented)
4351
protected _standardBuildFolders: StandardBuildFolders;
4452
// (undocumented)
4553
protected _taskOptions: TOptions;
@@ -93,7 +101,6 @@ export class TslintRunner extends RushStackCompilerBase<ITslintRunnerConfig> {
93101

94102
// @beta (undocumented)
95103
export class TypescriptCompiler extends RushStackCompilerBase<ITypescriptCompilerOptions> {
96-
constructor(rootPath: string, terminalProvider: ITerminalProvider);
97104
constructor(taskOptions: ITypescriptCompilerOptions, rootPath: string, terminalProvider: ITerminalProvider);
98105
// (undocumented)
99106
invoke(): Promise<void>;

‎common/reviews/api/rush-stack-compiler-3.2.api.md‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,31 +15,39 @@ import * as Typescript from 'typescript';
1515

1616
// @beta
1717
export class ApiExtractorRunner extends RushStackCompilerBase {
18-
constructor(extractorConfig: ExtractorConfig, extractorOptions: IExtractorInvokeOptions, rootPath: string, terminalProvider: ITerminalProvider);
18+
constructor(options: IRushStackCompilerBaseOptions, extractorConfig: ExtractorConfig, extractorOptions: IExtractorInvokeOptions, rootPath: string, terminalProvider: ITerminalProvider);
1919
// (undocumented)
2020
static apiExtractor: typeof ApiExtractor;
2121
// (undocumented)
2222
invoke(): Promise<void>;
2323
}
2424

2525
// @public (undocumented)
26-
export interface ITslintRunnerConfig {
27-
displayAsError?: boolean;
26+
export interface IRushStackCompilerBaseOptions {
2827
// (undocumented)
2928
fileError: WriteFileIssueFunction;
3029
// (undocumented)
3130
fileWarning: WriteFileIssueFunction;
3231
}
3332

33+
// @public (undocumented)
34+
export interface ITslintRunnerConfig extends IRushStackCompilerBaseOptions {
35+
displayAsError?: boolean;
36+
}
37+
3438
// @beta (undocumented)
35-
export interface ITypescriptCompilerOptions {
39+
export interface ITypescriptCompilerOptions extends IRushStackCompilerBaseOptions {
3640
customArgs?: string[];
3741
}
3842

3943
// @beta (undocumented)
40-
export abstract class RushStackCompilerBase<TOptions = {}> {
44+
export abstract class RushStackCompilerBase<TOptions extends IRushStackCompilerBaseOptions = IRushStackCompilerBaseOptions> {
4145
constructor(taskOptions: TOptions, rootPath: string, terminalProvider: ITerminalProvider);
4246
// (undocumented)
47+
protected _fileError: WriteFileIssueFunction;
48+
// (undocumented)
49+
protected _fileWarning: WriteFileIssueFunction;
50+
// (undocumented)
4351
protected _standardBuildFolders: StandardBuildFolders;
4452
// (undocumented)
4553
protected _taskOptions: TOptions;
@@ -93,7 +101,6 @@ export class TslintRunner extends RushStackCompilerBase<ITslintRunnerConfig> {
93101

94102
// @beta (undocumented)
95103
export class TypescriptCompiler extends RushStackCompilerBase<ITypescriptCompilerOptions> {
96-
constructor(rootPath: string, terminalProvider: ITerminalProvider);
97104
constructor(taskOptions: ITypescriptCompilerOptions, rootPath: string, terminalProvider: ITerminalProvider);
98105
// (undocumented)
99106
invoke(): Promise<void>;

0 commit comments

Comments
 (0)