Graham/angular-cli
1
0
Fork 0
mirror of https://github.com/angular/angular-cli.git synced 2025-05-16 18:43:42 +08:00
Code Issues Packages Projects Releases Wiki Activity

test: add new architect api to golden files

Browse Source
This commit is contained in:
Alan Agius 2019-04-12 13:35:00 +02:00 committed by Alex Eagle
parent eac31541a1
commit 260dacfb41
4 changed files with 91 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
etc/api/BUILD
View File

@ -30,6 +30,8 @@ load("@angular//tools/ts-api-guardian:index.bzl", "ts_api_guardian_test")
# We don't want to analyse these exports nor add them to the golden files
# in most cases it's because Ts API Guardian doesn't support Symbol Aliases.
strip_export_pattern = [
# @angular-devkit/architect
"^BuilderProgressState$",
# @angular-devkit/schematics
"^workflow$",
"^formats$",

13
etc/api/angular_devkit/architect/src/_golden-api.d.ts vendored
View File

@ -1,13 +0,0 @@
export declare class Architect {
constructor(_host: ArchitectHost, _registry?: json.schema.SchemaRegistry, additionalJobRegistry?: experimental.jobs.Registry);
has(name: experimental.jobs.JobName): Observable<boolean>;
scheduleBuilder(name: string, options: json.JsonObject, scheduleOptions?: ScheduleOptions): Promise<BuilderRun>;
scheduleTarget(target: Target, overrides?: json.JsonObject, scheduleOptions?: ScheduleOptions): Promise<BuilderRun>;
}
export declare function createBuilder<OptT extends json.JsonObject, OutT extends BuilderOutput = BuilderOutput>(fn: BuilderHandlerFn<OptT>): Builder<OptT>;
export interface ScheduleOptions {
analytics?: analytics.Analytics;
logger?: logging.Logger;
}

89
etc/api/angular_devkit/architect/src/index.d.ts vendored Normal file
View File

@ -0,0 +1,89 @@
export declare class Architect {
constructor(_host: ArchitectHost, _registry?: json.schema.SchemaRegistry, additionalJobRegistry?: experimental.jobs.Registry);
has(name: experimental.jobs.JobName): Observable<boolean>;
scheduleBuilder(name: string, options: json.JsonObject, scheduleOptions?: ScheduleOptions): Promise<BuilderRun>;
scheduleTarget(target: Target, overrides?: json.JsonObject, scheduleOptions?: ScheduleOptions): Promise<BuilderRun>;
}
export interface BuilderContext {
readonly analytics: analytics.Analytics;
builder: BuilderInfo;
currentDirectory: string;
id: number;
logger: logging.LoggerApi;
target?: Target;
workspaceRoot: string;
addTeardown(teardown: () => (Promise<void> | void)): void;
getBuilderNameForTarget(target: Target): Promise<string>;
getTargetOptions(target: Target): Promise<json.JsonObject>;
reportProgress(current: number, total?: number, status?: string): void;
reportRunning(): void;
reportStatus(status: string): void;
scheduleBuilder(builderName: string, options?: json.JsonObject, scheduleOptions?: ScheduleOptions): Promise<BuilderRun>;
scheduleTarget(target: Target, overrides?: json.JsonObject, scheduleOptions?: ScheduleOptions): Promise<BuilderRun>;
validateOptions<T extends json.JsonObject = json.JsonObject>(options: json.JsonObject, builderName: string): Promise<T>;
}
export interface BuilderHandlerFn<A extends json.JsonObject> {
(input: A, context: BuilderContext): BuilderOutputLike;
}
export declare type BuilderInfo = json.JsonObject & {
builderName: string;
description: string;
optionSchema: json.schema.JsonSchema;
};
export declare type BuilderInput = json.JsonObject & RealBuilderInput;
export declare type BuilderOutput = json.JsonObject & RealBuilderOutput;
export declare type BuilderOutputLike = Observable<BuilderOutput> | Promise<BuilderOutput> | BuilderOutput;
export declare type BuilderProgress = json.JsonObject & RealBuilderProgress & TypedBuilderProgress;
export declare type BuilderProgressReport = BuilderProgress & ({
target?: Target;
builder: BuilderInfo;
});
export declare type BuilderRegistry = experimental.jobs.Registry<json.JsonObject, BuilderInput, BuilderOutput>;
export interface BuilderRun {
id: number;
info: BuilderInfo;
output: Observable<BuilderOutput>;
progress: Observable<BuilderProgressReport>;
result: Promise<BuilderOutput>;
stop(): Promise<void>;
}
export declare function createBuilder<OptT extends json.JsonObject, OutT extends BuilderOutput = BuilderOutput>(fn: BuilderHandlerFn<OptT>): Builder<OptT>;
export interface ScheduleOptions {
analytics?: analytics.Analytics;
logger?: logging.Logger;
}
export declare function scheduleTargetAndForget(context: BuilderContext, target: Target, overrides?: json.JsonObject, scheduleOptions?: ScheduleOptions): Observable<BuilderOutput>;
export declare type Target = json.JsonObject & RealTarget;
export declare function targetFromTargetString(str: string): Target;
export declare function targetStringFromTarget({ project, target, configuration }: Target): string;
export declare type TypedBuilderProgress = ({
state: BuilderProgressState.Stopped;
} | {
state: BuilderProgressState.Error;
error: json.JsonValue;
} | {
state: BuilderProgressState.Waiting;
status?: string;
} | {
state: BuilderProgressState.Running;
status?: string;
current: number;
total?: number;
});

9
packages/angular_devkit/architect/src/_golden-api.d.ts vendored
View File

@ -1,9 +0,0 @@
/**
* @license
* Copyright Google Inc. All Rights Reserved.
*
* Use of this source code is governed by an MIT-style license that can be
* found in the LICENSE file at https://angular.io/license
*/
export { Architect, ScheduleOptions } from './architect';
export { createBuilder } from './create-builder';