Skip to content

Commit 1cb07ca

Browse files
clydinjosephperrott
authored andcommitted
build: transition from ts-api-guardian to dev-infra api-golden utility
The dev-infra tooling now directly provides public API change testing capabilities that leverage the `api-extractor` utility. These new testing capabilities are shared with framework and components. `ts-api-guardian` has been removed as a dependency as a result.
1 parent 222e711 commit 1cb07ca

File tree

36 files changed

+5810
-2264
lines changed

36 files changed

+5810
-2264
lines changed

goldens/BUILD.bazel

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
package(default_visibility = ["//visibility:public"])
2+
3+
filegroup(
4+
name = "public-api",
5+
srcs = glob([
6+
"public-api/**/*.md",
7+
]),
8+
)

goldens/public-api/BUILD.bazel

Lines changed: 0 additions & 54 deletions
This file was deleted.

goldens/public-api/angular_devkit/architect/src/index.d.ts

Lines changed: 0 additions & 95 deletions
This file was deleted.
Lines changed: 151 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,151 @@
1+
## API Report File for "@angular-devkit/architect"
2+
3+
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4+
5+
```ts
6+
7+
import { analytics } from '@angular-devkit/core';
8+
import { experimental } from '@angular-devkit/core';
9+
import { json } from '@angular-devkit/core';
10+
import { logging } from '@angular-devkit/core';
11+
import { Observable } from 'rxjs';
12+
import { SubscribableOrPromise } from 'rxjs';
13+
14+
// @public (undocumented)
15+
export class Architect {
16+
constructor(_host: ArchitectHost, registry?: json.schema.SchemaRegistry, additionalJobRegistry?: experimental.jobs.Registry);
17+
// (undocumented)
18+
has(name: experimental.jobs.JobName): Observable<boolean>;
19+
// (undocumented)
20+
scheduleBuilder(name: string, options: json.JsonObject, scheduleOptions?: ScheduleOptions): Promise<BuilderRun>;
21+
// (undocumented)
22+
scheduleTarget(target: Target, overrides?: json.JsonObject, scheduleOptions?: ScheduleOptions): Promise<BuilderRun>;
23+
}
24+
25+
// @public
26+
export interface BuilderContext {
27+
addTeardown(teardown: () => Promise<void> | void): void;
28+
readonly analytics: analytics.Analytics;
29+
builder: BuilderInfo;
30+
currentDirectory: string;
31+
getBuilderNameForTarget(target: Target): Promise<string>;
32+
// (undocumented)
33+
getProjectMetadata(projectName: string): Promise<json.JsonObject>;
34+
// (undocumented)
35+
getProjectMetadata(target: Target): Promise<json.JsonObject>;
36+
getTargetOptions(target: Target): Promise<json.JsonObject>;
37+
id: number;
38+
logger: logging.LoggerApi;
39+
reportProgress(current: number, total?: number, status?: string): void;
40+
reportRunning(): void;
41+
reportStatus(status: string): void;
42+
scheduleBuilder(builderName: string, options?: json.JsonObject, scheduleOptions?: ScheduleOptions_2): Promise<BuilderRun>;
43+
scheduleTarget(target: Target, overrides?: json.JsonObject, scheduleOptions?: ScheduleOptions_2): Promise<BuilderRun>;
44+
target?: Target;
45+
validateOptions<T extends json.JsonObject = json.JsonObject>(options: json.JsonObject, builderName: string): Promise<T>;
46+
workspaceRoot: string;
47+
}
48+
49+
// @public
50+
export interface BuilderHandlerFn<A> {
51+
(input: A, context: BuilderContext): BuilderOutputLike;
52+
}
53+
54+
// @public
55+
export type BuilderInfo = json.JsonObject & {
56+
builderName: string;
57+
description: string;
58+
optionSchema: json.schema.JsonSchema;
59+
};
60+
61+
// @public
62+
export type BuilderInput = json.JsonObject & Schema;
63+
64+
// @public (undocumented)
65+
export type BuilderOutput = json.JsonObject & Schema_2;
66+
67+
// @public
68+
export type BuilderOutputLike = AsyncIterable<BuilderOutput> | SubscribableOrPromise<BuilderOutput> | BuilderOutput;
69+
70+
// @public (undocumented)
71+
export type BuilderProgress = json.JsonObject & Schema_3 & TypedBuilderProgress;
72+
73+
// @public
74+
export type BuilderProgressReport = BuilderProgress & {
75+
target?: Target;
76+
builder: BuilderInfo;
77+
};
78+
79+
// @public (undocumented)
80+
export enum BuilderProgressState {
81+
// (undocumented)
82+
Error = "error",
83+
// (undocumented)
84+
Running = "running",
85+
// (undocumented)
86+
Stopped = "stopped",
87+
// (undocumented)
88+
Waiting = "waiting"
89+
}
90+
91+
// @public (undocumented)
92+
export type BuilderRegistry = experimental.jobs.Registry<json.JsonObject, BuilderInput, BuilderOutput>;
93+
94+
// @public
95+
export interface BuilderRun {
96+
id: number;
97+
info: BuilderInfo;
98+
output: Observable<BuilderOutput>;
99+
progress: Observable<BuilderProgressReport>;
100+
result: Promise<BuilderOutput>;
101+
stop(): Promise<void>;
102+
}
103+
104+
// @public (undocumented)
105+
export function createBuilder<OptT = json.JsonObject, OutT extends BuilderOutput = BuilderOutput>(fn: BuilderHandlerFn<OptT>): Builder<OptT & json.JsonObject>;
106+
107+
// @public (undocumented)
108+
export function fromAsyncIterable<T>(iterable: AsyncIterable<T>): Observable<T>;
109+
110+
// @public (undocumented)
111+
export function isBuilderOutput(obj: any): obj is BuilderOutput;
112+
113+
// @public (undocumented)
114+
export interface ScheduleOptions {
115+
// (undocumented)
116+
analytics?: analytics.Analytics;
117+
// (undocumented)
118+
logger?: logging.Logger;
119+
}
120+
121+
// @public
122+
export function scheduleTargetAndForget(context: BuilderContext, target: Target, overrides?: json.JsonObject, scheduleOptions?: ScheduleOptions_2): Observable<BuilderOutput>;
123+
124+
// @public (undocumented)
125+
export type Target = json.JsonObject & Target_2;
126+
127+
// @public
128+
export function targetFromTargetString(str: string): Target;
129+
130+
// @public
131+
export function targetStringFromTarget({ project, target, configuration }: Target): string;
132+
133+
// @public
134+
export type TypedBuilderProgress = {
135+
state: BuilderProgressState.Stopped;
136+
} | {
137+
state: BuilderProgressState.Error;
138+
error: json.JsonValue;
139+
} | {
140+
state: BuilderProgressState.Waiting;
141+
status?: string;
142+
} | {
143+
state: BuilderProgressState.Running;
144+
status?: string;
145+
current: number;
146+
total?: number;
147+
};
148+
149+
// (No @packageDocumentation comment for this package)
150+
151+
```

goldens/public-api/angular_devkit/architect/testing/index.d.ts

Lines changed: 0 additions & 31 deletions
This file was deleted.

0 commit comments

Comments
 (0)