Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 27e63e2

Browse files
committedApr 14, 2021
fix(@angular-devkit/build-angular): mark programmatic builder execution functions as experimental
While the builders when executed via the Angular CLI and their associated options are considered stable, the programmatic APIs are not considered officially supported and are not subject to the breaking change guarantees of SemVer. The programmatic APIs for the builders are now explicitly marked as experimental. This allows the package to use a stable versioning scheme while also continuing to provide access to the experimental programmatic API elements of the package.
1 parent 07bf174 commit 27e63e2

File tree

7 files changed

+30
-2
lines changed

7 files changed

+30
-2
lines changed
 

‎packages/angular_devkit/build_angular/src/browser/index.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,9 @@ import { Schema as BrowserBuilderSchema } from './schema';
7979

8080
const cacheDownlevelPath = cachingDisabled ? undefined : findCachePath('angular-build-dl');
8181

82+
/**
83+
* @experimental Direct usage of this type is considered experimental.
84+
*/
8285
export type BrowserBuilderOutput = json.JsonObject &
8386
BuilderOutput & {
8487
baseOutputPath: string;
@@ -186,6 +189,9 @@ async function initialize(
186189
return { config: transformedConfig || config, projectRoot, projectSourceRoot, i18n };
187190
}
188191

192+
/**
193+
* @experimental Direct usage of this function is considered experimental.
194+
*/
189195
// tslint:disable-next-line: no-big-function
190196
export function buildWebpackBrowser(
191197
options: BrowserBuilderSchema,

‎packages/angular_devkit/build_angular/src/dev-server/index.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,16 +62,21 @@ const devServerBuildOverriddenKeys: (keyof DevServerBuilderOptions)[] = [
6262
'deployUrl',
6363
];
6464

65+
/**
66+
* @experimental Direct usage of this type is considered experimental.
67+
*/
6568
export type DevServerBuilderOutput = DevServerBuildOutput & {
6669
baseUrl: string;
6770
};
6871

6972
/**
70-
* Reusable implementation of the build angular webpack dev server builder.
73+
* Reusable implementation of the Angular Webpack development server builder.
7174
* @param options Dev Server options.
7275
* @param context The build context.
7376
* @param transforms A map of transforms that can be used to hook into some logic (such as
7477
* transforming webpack configuration before passing it to webpack).
78+
*
79+
* @experimental Direct usage of this function is considered experimental.
7580
*/
7681
// tslint:disable-next-line: no-big-function
7782
export function serveWebpackBrowser(

‎packages/angular_devkit/build_angular/src/extract-i18n/index.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,9 @@ class NoEmitPlugin {
121121
}
122122
}
123123

124+
/**
125+
* @experimental Direct usage of this function is considered experimental.
126+
*/
124127
export async function execute(
125128
options: ExtractI18nBuilderOptions,
126129
context: BuilderContext,

‎packages/angular_devkit/build_angular/src/karma/index.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,9 @@ async function initialize(
6060
];
6161
}
6262

63+
/**
64+
* @experimental Direct usage of this function is considered experimental.
65+
*/
6366
export function execute(
6467
options: KarmaBuilderOptions,
6568
context: BuilderContext,

‎packages/angular_devkit/build_angular/src/ng-packagr/index.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,9 @@ async function initialize(
2626
return packager;
2727
}
2828

29+
/**
30+
* @experimental Direct usage of this function is considered experimental.
31+
*/
2932
export function execute(
3033
options: NgPackagrBuilderOptions,
3134
context: BuilderContext,

‎packages/angular_devkit/build_angular/src/protractor/index.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,9 @@ async function updateWebdriver() {
8585

8686
export { ProtractorBuilderOptions };
8787

88+
/**
89+
* @experimental Direct usage of this function is considered experimental.
90+
*/
8891
export async function execute(
8992
options: ProtractorBuilderOptions,
9093
context: BuilderContext,

‎packages/angular_devkit/build_angular/src/server/index.ts

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,9 @@ import {
3131
import { JsonCompilationStats, webpackStatsLogger } from '../webpack/utils/stats';
3232
import { Schema as ServerBuilderOptions } from './schema';
3333

34-
// If success is true, outputPath should be set.
34+
/**
35+
* @experimental Direct usage of this type is considered experimental.
36+
*/
3537
export type ServerBuilderOutput = json.JsonObject & BuilderOutput & {
3638
baseOutputPath: string;
3739
outputPaths: string[];
@@ -43,6 +45,9 @@ export type ServerBuilderOutput = json.JsonObject & BuilderOutput & {
4345

4446
export { ServerBuilderOptions };
4547

48+
/**
49+
* @experimental Direct usage of this function is considered experimental.
50+
*/
4651
export function execute(
4752
options: ServerBuilderOptions,
4853
context: BuilderContext,

0 commit comments

Comments
 (0)
Please sign in to comment.