diff --git a/goldens/public-api/angular/build/index.api.md b/goldens/public-api/angular/build/index.api.md index ca0a0b34f1ff..6c0dc155639c 100644 --- a/goldens/public-api/angular/build/index.api.md +++ b/goldens/public-api/angular/build/index.api.md @@ -158,7 +158,7 @@ export function executeExtractI18nBuilder(options: ExtractI18nBuilderOptions, co // @public export function executeKarmaBuilder(options: KarmaBuilderOptions, context: BuilderContext, transforms?: KarmaBuilderTransformsOptions): AsyncIterable; -// @public +// @public @deprecated export function executeNgPackagrBuilder(options: NgPackagrBuilderOptions, context: BuilderContext): AsyncIterableIterator; // @public @@ -208,7 +208,7 @@ export type KarmaBuilderOptions = { webWorkerTsConfig?: string; }; -// @public +// @public @deprecated export type NgPackagrBuilderOptions = { poll?: number; project?: string; diff --git a/goldens/public-api/angular_devkit/build_angular/index.api.md b/goldens/public-api/angular_devkit/build_angular/index.api.md index a7747bda9da2..9414547a18e6 100644 --- a/goldens/public-api/angular_devkit/build_angular/index.api.md +++ b/goldens/public-api/angular_devkit/build_angular/index.api.md @@ -170,7 +170,7 @@ export function executeKarmaBuilder(options: KarmaBuilderOptions, context: Build karmaOptions?: (options: KarmaConfigOptions) => KarmaConfigOptions; }): Observable; -// @public +// @public @deprecated export function executeNgPackagrBuilder(options: NgPackagrBuilderOptions, context: BuilderContext): Observable; // @public @@ -236,7 +236,7 @@ export type KarmaConfigOptions = ConfigOptions & { configFile?: string; }; -// @public +// @public @deprecated export type NgPackagrBuilderOptions = { poll?: number; project: string; diff --git a/packages/angular/build/builders.json b/packages/angular/build/builders.json index d73c7a18fe58..faca69ec8fcc 100644 --- a/packages/angular/build/builders.json +++ b/packages/angular/build/builders.json @@ -28,7 +28,7 @@ "ng-packagr": { "implementation": "./src/builders/ng-packagr/index", "schema": "./src/builders/ng-packagr/schema.json", - "description": "Build a library with ng-packagr." + "description": "Build a library with ng-packagr. (Deprecated: Use '@angular/build:library' instead.)" }, "unit-test": { "implementation": "./src/builders/unit-test", diff --git a/packages/angular/build/src/builders/ng-packagr/builder.ts b/packages/angular/build/src/builders/ng-packagr/builder.ts index 9e16e5fe54fb..3bbb2680d73c 100644 --- a/packages/angular/build/src/builders/ng-packagr/builder.ts +++ b/packages/angular/build/src/builders/ng-packagr/builder.ts @@ -22,11 +22,17 @@ import type { Schema as NgPackagrBuilderOptions } from './schema'; * @returns A BuilderOutput object. * * @experimental Direct usage of this function is considered experimental. + * @deprecated Use the `@angular/build:library` builder instead. Deprecated since v22.3. */ export async function* execute( options: NgPackagrBuilderOptions, context: BuilderContext, ): AsyncIterableIterator { + context.logger.warn( + 'The "@angular/build:ng-packagr" builder is deprecated. ' + + 'Use "@angular/build:library" instead.', + ); + // Purge old build disk cache. await purgeStaleBuildCache(context); diff --git a/packages/angular/build/src/builders/ng-packagr/schema.json b/packages/angular/build/src/builders/ng-packagr/schema.json index 0aa80ed6fe5f..94d8774d2af9 100644 --- a/packages/angular/build/src/builders/ng-packagr/schema.json +++ b/packages/angular/build/src/builders/ng-packagr/schema.json @@ -2,6 +2,7 @@ "$schema": "http://json-schema.org/draft-07/schema", "title": "ng-packagr Target", "description": "ng-packagr target options for Build Architect. Use to build library projects.", + "deprecated": true, "type": "object", "properties": { "project": { diff --git a/packages/angular_devkit/build_angular/src/builders/ng-packagr/index.ts b/packages/angular_devkit/build_angular/src/builders/ng-packagr/index.ts index 7523e2be45af..39a0cee515a5 100644 --- a/packages/angular_devkit/build_angular/src/builders/ng-packagr/index.ts +++ b/packages/angular_devkit/build_angular/src/builders/ng-packagr/index.ts @@ -17,6 +17,7 @@ import { Schema as NgPackagrBuilderOptions } from './schema'; /** * @experimental Direct usage of this function is considered experimental. + * @deprecated Use the `@angular/build:library` builder instead. */ export function execute( options: NgPackagrBuilderOptions, @@ -24,7 +25,7 @@ export function execute( ): Observable { context.logger.warn( 'The "@angular-devkit/build-angular:ng-packagr" builder is deprecated as part of Angular\'s Webpack support deprecation. ' + - 'Use "@angular/build:ng-packagr" instead. For more information, see https://angular.dev/tools/cli/build-system-migration.', + 'Use "@angular/build:library" instead. For more information, see https://angular.dev/tools/cli/build-system-migration.', ); return from( diff --git a/packages/angular_devkit/build_angular/src/builders/ng-packagr/schema.json b/packages/angular_devkit/build_angular/src/builders/ng-packagr/schema.json index da76255f092a..f3eaa8d00bec 100644 --- a/packages/angular_devkit/build_angular/src/builders/ng-packagr/schema.json +++ b/packages/angular_devkit/build_angular/src/builders/ng-packagr/schema.json @@ -2,6 +2,7 @@ "$schema": "http://json-schema.org/draft-07/schema", "title": "ng-packagr Target", "description": "ng-packagr target options for Build Architect. Use to build library projects.", + "deprecated": true, "type": "object", "properties": { "project": { diff --git a/packages/schematics/angular/utility/workspace-models.ts b/packages/schematics/angular/utility/workspace-models.ts index 51c9c9dbdc9f..6f84a84f9e27 100644 --- a/packages/schematics/angular/utility/workspace-models.ts +++ b/packages/schematics/angular/utility/workspace-models.ts @@ -29,7 +29,11 @@ export enum Builders { BuildKarma = '@angular/build:karma', BuildUnitTest = '@angular/build:unit-test', TsLint = '@angular-devkit/build-angular:tslint', + + /** @deprecated Use `BuildLibrary` instead. */ NgPackagr = '@angular-devkit/build-angular:ng-packagr', + + /** @deprecated Use `BuildLibrary` instead. */ BuildNgPackagr = '@angular/build:ng-packagr', DevServer = '@angular-devkit/build-angular:dev-server', BuildDevServer = '@angular/build:dev-server', @@ -82,6 +86,7 @@ export interface ServeBuilderOptions { buildTarget: string; } +/** @deprecated */ export interface LibraryBuilderOptions { tsConfig: string; project: string; @@ -135,6 +140,7 @@ export interface BuilderTarget { }; } +/** @deprecated */ export type LibraryBuilderTarget = BuilderTarget; export type BrowserBuilderTarget = BuilderTarget; export type ServerBuilderTarget = BuilderTarget; diff --git a/tools/quicktype_runner.js b/tools/quicktype_runner.js index be4745f62842..4fb99a56874e 100644 --- a/tools/quicktype_runner.js +++ b/tools/quicktype_runner.js @@ -144,6 +144,14 @@ async function generate(inPath) { */ function appendDeprecatedDescription(schema) { const content = JSON.parse(schema); + const rootDeprecated = content['x-deprecated'] ?? content['deprecated']; + if (rootDeprecated) { + content.description = + (content.description ? content.description + '\n' : '') + + '@deprecated' + + (typeof rootDeprecated === 'string' ? ` ${rootDeprecated}` : ''); + } + const props = content.properties; for (const key in props) {