Skip to content

refactor(@angular-devkit/build-angular): update esbuild builder option status messages #25091

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
angular-robot merged 1 commit into from
Apr 28, 2023
Merged

refactor(@angular-devkit/build-angular): update esbuild builder option status messages #25091

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 19 additions & 8 deletions .../browser-esbuild/experimental-warnings.ts → ...rowser-esbuild/builder-status-warnings.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,22 @@ const UNSUPPORTED_OPTIONS: Array<keyof BrowserBuilderOptions> = [
// * Always enabled with esbuild
// 'commonChunk',

// * Currently unsupported by esbuild
// * Unused by builder and will be removed in a future release
'namedChunks',
'vendorChunk',

// * Currently unsupported by esbuild
'webWorkerTsConfig',
];

export function logExperimentalWarnings(options: BrowserEsbuildOptions, context: BuilderContext) {
// Warn about experimental status of this builder
export function logBuilderStatusWarnings(options: BrowserEsbuildOptions, context: BuilderContext) {
context.logger.warn(
`The esbuild browser application builder ('browser-esbuild') is currently experimental.`,
`The esbuild-based browser application builder ('browser-esbuild') is currently in developer preview` +
' and is not yet recommended for production use.' +
' For additional information, please see https://angular.io/guide/esbuild',
);

// Validate supported options
// Currently only a subset of the Webpack-based browser builder options are supported.
for (const unsupportedOption of UNSUPPORTED_OPTIONS) {
const value = (options as unknown as BrowserBuilderOptions)[unsupportedOption];

Expand All @@ -52,8 +54,17 @@ export function logExperimentalWarnings(options: BrowserEsbuildOptions, context:
continue;
}

context.logger.warn(
`The '${unsupportedOption}' option is currently unsupported by this experimental builder and will be ignored.`,
);
if (
unsupportedOption === 'namedChunks' ||
unsupportedOption === 'vendorChunk' ||
unsupportedOption === 'deployUrl'
) {
context.logger.warn(
`The '${unsupportedOption}' option is not used by this builder and will be ignored.`,
);
continue;
}

context.logger.warn(`The '${unsupportedOption}' option is not yet supported by this builder.`);
}
}
6 changes: 3 additions & 3 deletions packages/angular_devkit/build_angular/src/builders/browser-esbuild/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ import { Spinner } from '../../utils/spinner';
import { getSupportedBrowsers } from '../../utils/supported-browsers';
import { BundleStats, generateBuildStatsTable } from '../../webpack/utils/stats';
import { SourceFileCache, createCompilerPlugin } from './angular/compiler-plugin';
import { logBuilderStatusWarnings } from './builder-status-warnings';
import { checkCommonJSModules } from './commonjs-checker';
import { BundlerContext, logMessages } from './esbuild';
import { logExperimentalWarnings } from './experimental-warnings';
import { createGlobalScriptsBundleOptions } from './global-scripts';
import { extractLicenses } from './license-extractor';
import { LoadResultCache } from './load-result-cache';
Expand Down Expand Up @@ -623,8 +623,8 @@ export async function* buildEsbuildBrowserInternal(
assetFiles?: { source: string; destination: string }[];
}
> {
// Inform user of experimental status of builder and options
logExperimentalWarnings(userOptions, context);
// Inform user of status of builder and options
logBuilderStatusWarnings(userOptions, context);

// Determine project name from builder context target
const projectName = context.target?.project;
Expand Down