@angular-devkit/core

What is @angular-devkit/core?

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.

What are @angular-devkit/core's main functionalities?

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}"}

Other packages similar to @angular-devkit/core

yeoman-generator

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.

fs-extra

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.

webpack

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.

README

Core

Shared utilities for Angular DevKit.

Exception

Json

Schema

SchemaValidatorResult

export interface SchemaValidatorResult {
  success: boolean;
  errors?: string[];
}

SchemaValidator

export interface SchemaValidator {
  (data: any): Observable<SchemaValidatorResult>;
}

SchemaFormatter

export interface SchemaFormatter {
  readonly async: boolean;
  validate(data: any): boolean | Observable<boolean>;
}

SchemaRegistry

export interface SchemaRegistry {
  compile(schema: Object): Observable<SchemaValidator>;
  addFormat(name: string, formatter: SchemaFormatter): void;
}

CoreSchemaRegistry

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} = {}) {}
}

Logger

Utils

Virtual FS

Changelog

17.0.10 (2024-01-10)

@angular/cli

| Commit | Type | Description | | --------------------------------------------------------------------------------------------------- | ---- | -------------------------------------------- | | ed1e130da | fix | retain existing EOL when updating JSON files |

@schematics/angular

| Commit | Type | Description | | --------------------------------------------------------------------------------------------------- | ---- | -------------------------------------------- | | 09c32c678 | fix | retain existing EOL when adding imports | | a5c339eaa | fix | retain existing EOL when updating JSON files |

@angular-devkit/core

| Commit | Type | Description | | --------------------------------------------------------------------------------------------------- | ---- | -------------------------------------------------- | | 3dc4db7d7 | fix | retain existing EOL when updating workspace config |

<!-- CHANGELOG SPLIT MARKER -->

<a name="17.0.9"></a>