angular/packages/compiler-cli/linker
Alex Rickabaugh a006edefd1 refactor(compiler-cli): introduce onlyPublishPublicTypingsForNgModules (#45894)
When generating .d.ts metadata for NgModules, by default we emit type
references to their declarations, imports, and exports. However, this
information is not necessarily useful to consumers. References to private
directives (those that aren't exported by the NgModule) for example aren't
at all useful as they can only affect other components declared in the
NgModule. References to imports are of limited usefulness - they might be
helpful for an IDE to understand the DI structure of an application, but
aren't at all used by a downstream compiler.

Generating this metadata is not without cost. When an incremental build
system uses changes in inputs to determine when a rebuild is necessary, any
changes in .d.ts files might cause downstream targets to rebuild. If those
.d.ts changes are in the "private" side of the NgModule (imports or non-
exported directives/pipes), then these rebuilds are wholly unnecessary.

This commit introduces the `onlyPublishPublicTypingsForNgModules` flag for
the compiler. When this flag is set, the compiler will filter the emitted
references in NgModule .d.ts output and only reference those directives/
pipes that are exported from the NgModule (its public API surface). Omitting
the flag preserves the existing behavior of emitting all references, both
public and private.

This is especially useful for build systems such as Bazel.

PR Close #45894
2022-06-02 13:39:14 -07:00
..
babel ci: fix formatting for babel_ast_host.ts file after recent changes (#46082) 2022-05-23 13:30:38 -07:00
src refactor(compiler-cli): introduce onlyPublishPublicTypingsForNgModules (#45894) 2022-06-02 13:39:14 -07:00
test refactor(compiler-cli): linker honors associated statements for a field (#45024) 2022-03-22 11:11:53 -07:00
BUILD.bazel refactor(compiler-cli): support external template source-mapping when linking (#40237) 2021-01-07 13:12:53 -08:00
index.ts refactor(compiler-cli): implement ɵɵngDeclareNgModule and ɵɵngDeclareInjector (#41080) 2021-03-15 13:26:51 -07:00
README.md refactor(compiler-cli): linker - add Babel plugin, FileLinker and initial PartialLinkers (#39116) 2020-10-19 11:23:45 -07:00

Angular Linker

This package contains a FileLinker and supporting code to be able to "link" partial declarations of components, directives, etc in libraries to produce the full definitions.

The partial declaration format allows library packages to be published to npm without exposing the underlying Ivy instructions.

The tooling here allows application build tools (e.g. CLI) to produce fully compiled components, directives, etc at the point when the application is bundled. These linked files can be cached outside node_modules so it does not suffer from problems of mutating packages in node_modules.

Generally this tooling will be wrapped in a transpiler specific plugin, such as the provided Babel plugin.

Unit Testing

The unit tests are built and run using Bazel:

yarn bazel test //packages/compiler-cli/linker/test