@angular-devkit/core
Advanced tools
Package description
The @angular-devkit/core package is a fundamental part of the Angular DevKit which provides utility functions and an abstraction layer for managing file systems and other common tasks needed in the development of Angular applications. It is designed to be used by the Angular CLI and other tools to enhance and streamline the development process.
Virtual File System
Allows manipulation of file systems in memory, which is useful for testing and build processes without affecting the actual file system.
{"import { virtualFs, HostTree } from '@angular-devkit/core';\nconst host = new HostTree();\nhost.create('/hello', 'world');\nconst exists = host.exists('/hello');\nconsole.log(exists); // true"}Workspace Configuration
Provides utilities to read and manipulate Angular workspace configuration, enabling tools and scripts to modify project settings programmatically.
{"import { workspaces } from '@angular-devkit/core';\nasync function getWorkspace() {\n const workspaceHost = workspaces.createWorkspaceHost(host);\n const { workspace } = await workspaces.readWorkspace('/', workspaceHost);\n console.log(workspace.projects.get('my-app'));\n}"}Schematics
Supports the creation and execution of schematics which are templates used to generate or transform projects. This feature is crucial for extending the Angular CLI's capabilities.
{"import { SchematicContext, Tree, Rule } from '@angular-devkit/schematics';\nfunction mySchematic(_options: any): Rule {\n return (tree: Tree, _context: SchematicContext) => {\n tree.create('hello.txt', 'Hello World');\n return tree;\n };\n}"}Similar to the schematics functionality of @angular-devkit/core, Yeoman generators allow the creation of projects or parts of projects through templates. However, Yeoman is more generic and not Angular-specific.
Provides extended functionality for the Node.js file system module, similar to the virtual file system capabilities of @angular-devkit/core, but operates on the actual file system rather than a virtual one.
While primarily a module bundler, webpack offers a rich plugin interface that can perform similar tasks to those of @angular-devkit/core, such as manipulating files and project assets. However, it is more focused on the build process rather than project scaffolding or configuration.
Changelog
17.0.0 (2023-11-08)
ng generate application and ng new. The --no-routing command line option can be used to disable this behaviour.ng g interceptor now generate a functional interceptor by default. or guard by default. To generate a class-based interceptor the --no-functional command flag should be used.rootModuleClassName, rootModuleFileName and main options have been removed from the public pwa and app-shell schematics.appId option has been removed.Node.js v16 support has been removed
Node.js v16 is planned to be End-of-Life on 2023-09-11. Angular will stop supporting Node.js v16 in Angular v17. For Node.js release schedule details, please see: https://github.com/nodejs/release#release-schedule
runExternalSchematicAsync and runSchematicAsync methods have been removed in favor of runExternalSchematic and runSchematic.browserTarget in the dev-server and extract-i18n builders have been deprecated in favor of buildTarget.| Commit | Type | Description |
| --------------------------------------------------------------------------------------------------- | ---- | ---------------------------------------------------------- |
| f4e7fa873 | fix | add @angular/ssr as part of the ng update packageGroup |
| 1f7156b11 | fix | add Node.js 20 as supported version |
| 4b9a87c90 | fix | ignore peer mismatch when updating @nguniversal/builders |
| f66f9cf61 | fix | remove Node.js 16 from supported checks |
| Commit | Type | Description |
| --------------------------------------------------------------------------------------------------- | -------- | -------------------------------------------------------------------- |
| 741cca73c | feat | add ng new --ssr |
| 3938863b9 | feat | add migration to migrate from @nguniversal to @angular/ssr |
| dc6b6eaf6 | feat | add migration to replace usages of @nguniversal/builders |
| 6979eba3c | feat | enable hydration when adding SSR, SSG or AppShell |
| 1a6a139aa | feat | enable routing by default for new applications |
| ac0db6697 | feat | enable standalone by default in new applications |
| a189962a5 | feat | generate functional interceptors by default |
| ae45c4ab8 | feat | update ng new generated application |
| 3f8aa9d8c | feat | update ng new to use the esbuild application builder based builder |
| 03a1eaf01 | fix | account for new block syntax in starter template |
| eb0fc7434 | fix | add missing express REQUEST and RESPONSE tokens |
| ecdcff2db | fix | add missing icons in ng-new template |
| 175944672 | fix | do not add unnecessary dependency on @angular/ssr during migration |
| 23c4c5e42 | fix | enable TypeScript esModuleInterop by default for ESM compliance |
| d60a6e86a | fix | noop workspace config migration when already executed |
| e516a4bdb | fix | pass ssr option to application schematics |
| 419b5c191 | fix | remove baseUrl from tsconfig.json |
| 0368b23f2 | fix | use @types/node v18 |
| b15e82758 | refactor | remove deprecated appId option |
| Commit | Type | Description |
| --------------------------------------------------------------------------------------------------- | ---- | --------------------------------------------------------------------------------------------------------------- |
| c48982dc1 | feat | add buildTarget option to dev-server and extract-i18n builders |
| 1fb0350eb | feat | add initial support for bundle budgets to esbuild builders |
| 8168ae2a8 | feat | apply global CSS updates without a live-reload when using vite |
| 91019bde2 | feat | enable localize support for SSR with application builder |
| 3c0719bde | feat | initial i18n extraction support for application builder |
| 8bce80b91 | feat | initial support for application Web Worker discovery with esbuild |
| 49f07a84d | feat | standardize application builder output structure |
| c3a87a60e | feat | support basic web worker bundling with esbuild builders |
| 9e425308a | feat | support component style budgets in esbuild builders |
| 771e036d5 | feat | support deploy URL option for browser-esbuild builder |
| c5f3ec71f | feat | support i18n inlining with esbuild-based builder |
| fd62a9315 | feat | support i18n with service worker and app-shell with esbuild builders |
| 5898f72a9 | feat | support namedChunks option in application builder |
| 8f9a0d70c | feat | support standalone apps route discovery during prerendering |
| 6b08efa6f | fix | account for arrow function IIFE |
| 2f299fc7b | fix | account for styles specified as string literals and styleUrl |
| 9994b2dde | fix | add a maximum rendering timeout for SSR and SSG during development |
| da4e19145 | fix | address a path concatenation on Windows |
| 9d4d11cc4 | fix | allow SSR compilation to work with TS allowJs option |
| e3c5b91e8 | fix | automatically include known packages in vite prebundling |
| ca38ee34c | fix | avoid binary content in architect results with browser-esbuild |
| 657f78292 | fix | avoid dev server update analysis when build fails with vite |
| 2c33f09db | fix | avoid dev-server proxy rewrite normalization when invalid value |
| b182be8aa | fix | avoid in-memory prerendering ESM loader errors |
| 0c982b993 | fix | avoid repeat error clear in vite development server |
| e41e2015b | fix | avoid spawning workers when there are no routes to prerender |
| 2d2e79921 | fix | clean up internal Angular state during rendering SSR |
| 83020fc32 | fix | clear diagnostic cache when external templates change with esbuild builders |
| c12f98f94 | fix | conditionally enable deprecated Less stylesheet JavaScript support |
| e10f49efa | fix | convert AOT compiler exceptions into diagnostics |
| 667f43af6 | fix | correctly resolve polyfills when baseUrl URL is not set to root |
| d46fb128a | fix | disable dependency optimization for SSR |
| 1b384308c | fix | disable parallel TS/NG compilation inside WebContainers |
| 070da72c4 | fix | do not perform advanced optimizations on @angular/common/locales/global |
| 508c7606e | fix | do not print Angular is running in development mode. in the server console when running prerender in dev mode |
| e817656f6 | fix | do not print Angular is running in development mode. in the server console when running prerender in dev mode |
| f806e3498 | fix | elide setClassDebugInfo calls |
| 188a00f3e | fix | elide setClassMetadataAsync calls |
| 05ce9d697 | fix | ensure all SSR chunks are resolved correctly with dev server |
| d392d653c | fix | ensure correct web worker URL resolution in vite dev server |
| 1a6aa4378 | fix | ensure css url() prefix warnings support Sass rebasing |
| 52f595655 | fix | ensure i18n locale data is included in SSR application builds |
| 3ad028bb4 | fix | ensure localize polyfill and locale specifier are injected when not inlining |
| 3e5a99c2c | fix | ensure recalculation of component diagnostics when template changes |
| fa234a418 | fix | ensure secondary Angular compilations are unblocked on start errors |
| c0c7dad77 | fix | ensure that externalMetadata is defined |
| ac7caa426 | fix | ensure unique internal identifiers for inline stylesheet bundling |
| 1f73bcc49 | fix | ensure Web Worker code file is replaced in esbuild builders |
| 23a722b79 | fix | exclude node.js built-ins from vite dependency optimization |
| fd2c4c324 | fix | expose ssr-dev-server builder in the public api |
| 9eb58cf7a | fix | fail build on non bundling error when using the esbuild based builders |
| a3e9efe80 | fix | fully track Web Worker file changes in watch mode |
| b9505ed09 | fix | generate a file containing a list of prerendered routes |
| 192a2ae6b | fix | handle HTTP requests to assets during prerendering |
| 19191e32b | fix | handle HTTP requests to assets during SSG in dev-server |
| 8981d8c35 | fix | improve sharing of TypeScript compilation state between various esbuild instances during rebuilds |
| 5a3ae0159 | fix | in vite skip SSR middleware for path with extensions |
| f87f22d3f | fix | keep dependencies pre-bundling validate between builds |
| 0da87bf1c | fix | limit concurrent output file writes with application builder |
| 391ff78cb | fix | log number of prerendered routes in console |
| c46f312ad | fix | media files download files in vite |
| 87425a791 | fix | normalize paths when invalidating stylesheet bundler |
| d4f37da50 | fix | only show changed output files in watch mode with esbuild |
| 0d54f2d20 | fix | only watch used files with application builder |
| 1f299ff2d | fix | prebundle dependencies for SSR when using Vite |
| 58bd3971f | fix | process nested tailwind usage in application builder |
| 60ca3c82d | fix | provide server baseUrl result property in Vite-based dev server |
| 0c20cc4dc | fix | re-add TestBed compileComponents in schematics to support defer block testing |
| 9453a2380 | fix | remove CJS usage warnings for inactionable packages |
| 5bf7022c4 | fix | remove support for Node.js v16 |
| c27ad719f | fix | remove unactionable error overlay suggestion from Vite-based dev server |
| 263271fae | fix | resolve and load sourcemaps during prerendering to provide better stacktraces |
| 651e3195f | fix | resolve and load sourcemaps when using vite dev server with prerendering and ssr |
| b78508fc8 | fix | several fixes to assets and files writes in browser-esbuild builder |
| c4c299bce | fix | silence xhr2 not ESM module warning |
| f7f6e97d0 | fix | skip checking CommonJS module descendants |
| c11a0f0d3 | fix | support custom index option paths in Vite-based dev server |
| 6c3d7d1c1 | fix | update ssr option definition |
| 4e89c3cae | fix | use a dash in bundle names |
| 83b4b2567 | fix | use browserslist when processing global scripts in application builder |
| ca4d1634f | fix | use component style load result caching information for file watching |
| 34947fc64 | fix | use incremental component style bundling only in watch mode |
| ec160fe4e | fix | warn if using partial mode with application builder |
| 559e89159 | fix | Windows Node.js 20 prerendering failure (#26186) |
| 2cbec36c7 | perf | cache polyfills virtual module result |
| e06e95f73 | perf | conditionally add Angular compiler plugin to polyfills bundling |
| 61f409cbe | perf | disable ahead of time prerendering in vite dev-server |
| 01ab16c5d | perf | fully avoid rebuild of component stylesheets when unchanged |
| 99d9037ee | perf | only perform a server build when either prerendering, app-shell or ssr is enabled |
| c013a95e2 | perf | only rebundle browser polyfills on explicit changes |
| e68a662bc | perf | only rebundle global scripts/styles on explicit changes |
| 28d9ab88f | perf | only rebundle server polyfills on explicit changes |
| 6d3942723 | perf | optimize server or browser only dependencies once |
| 2e8e9d802 | perf | patch fetch to load assets from memory |
| 49fe74e24 | perf | reduce CLI loading times by removing critters from critical path |
| 07e2120da | perf | remove JavaScript transformer from server polyfills bundling |
| c28475d30 | perf | reuse esbuild generated output file hashes |
| 59c22aa4c | perf | start SSR dependencies optimization before the first request |
| 223a82f5f | perf | use incremental bundling for component styles in esbuild builders |
| 4b67d2afd | perf | use single JS transformer instance during dev-server prebundling |
| Commit | Type | Description |
| --------------------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------- |
| f600bbc97 | refactor | remove deprecated runExternalSchematicAsync and runSchematicAsync |
| Commit | Type | Description | | --------------------------------------------------------------------------------------------------- | ---- | --------------------- | | 81e4917ce | fix | replace Angular logos |
| Commit | Type | Description |
| --------------------------------------------------------------------------------------------------- | ---- | -------------------------------------------------------- |
| dcf3fddff | feat | add performance profiler to CommonEngine |
| 6224b0599 | fix | correctly set config URL |
| 8d033841d | fix | enable prerender and ssr for all build configuration |
| ee0991bed | fix | enable performance profiler option name |
| Commit | Type | Description | | --------------------------------------------------------------------------------------------------- | ---- | ----------------------------------------------------------------- | | f43754570 | feat | add automated preconnects for image domains | | 4fe03266a | fix | account for arrow function IIFE | | 828030da0 | fix | account for styles specified as string literals and styleUrl | | 16428fc97 | fix | adjust static scan to find image domains in standlone components | | 486becdbb | fix | remove setClassDebugInfo calls | | 89f21ac8c | fix | remove setClassMetadataAsync calls | | 8899fb9e3 | fix | skip transforming empty inline styles in Webpack JIT compilations |
<!-- CHANGELOG SPLIT MARKER --><a name="16.2.10"></a>
Readme
Shared utilities for Angular DevKit.
export interface SchemaValidatorResult {
success: boolean;
errors?: string[];
}
export interface SchemaValidator {
(data: any): Observable<SchemaValidatorResult>;
}
export interface SchemaFormatter {
readonly async: boolean;
validate(data: any): boolean | Observable<boolean>;
}
export interface SchemaRegistry {
compile(schema: Object): Observable<SchemaValidator>;
addFormat(name: string, formatter: SchemaFormatter): void;
}
SchemaRegistry implementation using https://github.com/epoberezkin/ajv.
Constructor accepts object containing SchemaFormatter that will be added automatically.
export class CoreSchemaRegistry implements SchemaRegistry {
constructor(formats: { [name: string]: SchemaFormatter} = {}) {}
}
The workspaces namespace provides an API for interacting with the workspace file formats.
It provides an abstraction of the underlying storage format of the workspace and provides
support for both reading and writing. Currently, the only supported format is the JSON-based
format used by the Angular CLI. For this format, the API provides internal change tracking of values which
enables fine-grained updates to the underlying storage of the workspace. This allows for the
retention of existing formatting and comments.
A workspace is defined via the following object model. Definition collection objects are specialized
Javascript Map objects with an additional add method to simplify addition and provide more localized
error checking of the newly added values.
export interface WorkspaceDefinition {
readonly extensions: Record<string, JsonValue | undefined>;
readonly projects: ProjectDefinitionCollection;
}
export interface ProjectDefinition {
readonly extensions: Record<string, JsonValue | undefined>;
readonly targets: TargetDefinitionCollection;
root: string;
prefix?: string;
sourceRoot?: string;
}
export interface TargetDefinition {
options?: Record<string, JsonValue | undefined>;
configurations?: Record<string, Record<string, JsonValue | undefined> | undefined>;
builder: string;
}
The API is asynchronous and has two main functions to facilitate reading, creation, and modifying
a workspace: readWorkspace and writeWorkspace.
export enum WorkspaceFormat {
JSON,
}
export function readWorkspace(
path: string,
host: WorkspaceHost,
format?: WorkspaceFormat,
): Promise<{ workspace: WorkspaceDefinition }>;
export function writeWorkspace(
workspace: WorkspaceDefinition,
host: WorkspaceHost,
path?: string,
format?: WorkspaceFormat,
): Promise<void>;
A WorkspaceHost abstracts the underlying data access methods from the functions. It provides
methods to read, write, and analyze paths. A utility function is provided to create
an instance of a WorkspaceHost from the Angular DevKit's virtual filesystem host abstraction.
export interface WorkspaceHost {
readFile(path: string): Promise<string>;
writeFile(path: string, data: string): Promise<void>;
isDirectory(path: string): Promise<boolean>;
isFile(path: string): Promise<boolean>;
}
export function createWorkspaceHost(host: virtualFs.Host): WorkspaceHost;
To demonstrate the usage of the API, the following code will show how to add a option property to a build target for an application.
import { NodeJsSyncHost } from '@angular-devkit/core/node';
import { workspaces } from '@angular-devkit/core';
async function demonstrate() {
const host = workspaces.createWorkspaceHost(new NodeJsSyncHost());
const { workspace } = await workspaces.readWorkspace('path/to/workspace/directory/', host);
const project = workspace.projects.get('my-app');
if (!project) {
throw new Error('my-app does not exist');
}
const buildTarget = project.targets.get('build');
if (!buildTarget) {
throw new Error('build target does not exist');
}
buildTarget.options.optimization = true;
await workspaces.writeWorkspace(workspace, host);
}
demonstrate();
FAQs
Unknown package
We found that @angular-devkit/core demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
A threat actor on BreachForums is selling an unverified npm vulnerability for account takeover, but npm has not officially confirmed the existence of this security concern.
Security News
Cyber insurance rates are dropping as the market matures, according to a new report projecting global premiums to reach $43 billion by 2030, driven by international market uptake and growth in the SME sector.
Research
Security News
Socket researchers unpack a typosquatting package with malicious code that logs keystrokes and exfiltrates sensitive data to a remote server.