Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@crexi-dev/ng-packagr

ng-packagr86MIT9.2.2TypeScript support: included

Compile and package a TypeScript library to Angular Package Format

angular, angular2, angular4, angular-library, angular-components, component-library, typescript, css, scss, html

readme

ng-packagr

Transpile your libraries to Angular Package Format

npm npm License Conventional Commits CircleCI

GitHub contributors GitHub stars npm Downloads Renovate enabled

Credits

Contributors

This project exists thanks to all the people who contribute. [Contribute].

Installation

npm install -D ng-packagr

Usage Example

Let's walk through a getting started that'll build an Angular library from TypeScript sources and create a distribution-ready npm package: create a package.json file, add the custom ngPackage property, and eventually run ng-packagr -p package.json – Here we go:

{
  "$schema": "./node_modules/ng-packagr/package.schema.json",
  "name": "@my/foo",
  "version": "1.0.0",
  "ngPackage": {
    "lib": {
      "entryFile": "public_api.ts"
    }
  }
}

Note 1: Paths in the ngPackage section are resolved relative to the location of the package.json file. In the above example, public_api.ts is the entry file to the library's sources and must be placed next to package.json (a sibling in the same folder).

Note 2: referencing the $schema enables JSON editing support (auto-completion for configuration) in IDEs like VSCode.

You can easily run ng-packagr through a npm/yarn script:

{
  "scripts": {
    "build": "ng-packagr -p package.json"
  }
}

Now, execute the build with the following command:

$ yarn build

The build output is written to the dist folder, containing all those binaries to meet the Angular Package Format specification. You'll now be able to go ahead and npm publish dist your Angular library to the npm registry.

Do you like to publish more libraries? Is your code living in a monorepo? Create one package.json per npm package, run ng-packagr for each!

Features

  • :gift: Implements Angular Package Format
    • :checkered_flag: Bundles your library in FESM2015, FESM5, and UMD formats
    • :school_satchel: npm package can be consumed by Angular CLI, Webpack, or SystemJS
    • :dancer: Creates type definitions (.d.ts)
    • :runner: Generates Ahead-of-Time metadata (.metadata.json)
    • :trophy: Auto-discovers and bundles secondary entry points such as @my/foo, @my/foo/testing, @my/foo/bar
  • :mag_right: Creates scoped and non-scoped packages for publishing to npm registry
  • :surfer: Inlines Templates and Stylesheets
  • :sparkles: CSS Features

How to…

Advanced Use Cases

Examples and Tutorials

A great step-by-step example of making an Angular CLI project with a library distributed separate from the app, by Jason Aden

Nikolas LeBlanc wrote a tutorial on building an Angular 4 Component Library with the Angular CLI and ng-packagr

Here is a demo repository showing ng-packagr and Angular CLI in action.

What about ng-packagr alongside Nx Workspace? Well, they work well together!

Further user questions and issue-driven documentation

We keep track of user questions in GitHub's issue tracker and try to build a documentation from it. Explore issues w/ label documentation.

Contributing to ng-packagr

General contribution guidelines

If you like to submit a pull request, you'll find it helpful to take a look at the initial design document where it all started.

To orchestrate the different tools, ng-packagr features a custom transformation pipeline. The transformation pipeline is built on top of RxJS and Angular Dependency Injection concepts.

Knowledge

Angular Package Format v9.0, design document at Google Docs

Packaging Angular Libraries - Jason Aden at Angular Mountain View Meetup (Jan 2018, 45min talk)

Create and publish Angular libs like a Pro - Juri Strumpflohner at NG-BE (Dec 2017, 30min talk)

Juri Strumpflohner - Create and publish Angular libs like a Pro

Packaging Angular - Jason Aden at ng-conf 2017 (28min talk)

Packaging Angular - Jason Aden

Create and publish Angular libs like a Pro - Juri Strumpflohner at ngVikings, this time demoing building Angular libraries with ng-packagr, with NX as well as Bazel (March 2018, 30min talk)

Juri Strumpflohner - Create & Publish Angular Libs like a PRO at ngVikings

changelog

Changelog

All notable changes to this project will be documented in this file. See standard-version for commit guidelines.

9.1.0 (2020-03-25)

Bug Fixes

  • update @angular/common to version ~9.1.0 (fd8c0a9)
  • update fs-extra to version ^9.0.0 (eb2cd7f)
  • update rollup to version 2.2.0 (1de8443)

Features

  • add support for TypeScript 3.8 (4a388af)

9.0.3 (2020-03-09)

Bug Fixes

  • update rollup to version 1.32.0 (0e414ce)
  • update rollup to version 1.32.1 (9611545)
  • wrong UMD ID's of Angular packages with a dash in name (c996a61)

9.0.2 (2020-02-25)

Bug Fixes

  • handle union type with a nullable argument (c9f697f)
  • show schema errors (cdf0e9c)
  • throw error on circular dependencies (af1d2f3), closes #1551
  • update rollup to version 1.31.1 (36830f4)

9.0.1 (2020-02-18)

Bug Fixes

  • update rollup to version 1.31.1 (36830f4)

9.0.0 (2020-02-06)

⚠ BREAKING CHANGES

  • Remove usage of deprecated less-plugin-npm-import. In less v3 is supports node_modules resolutions by default.

Before

@import '~module/less/linenumbers';

After

@import 'module/less/linenumbers';
  • TypeScript versions prior to 3.6.4 are no longer supported.no longer supported.
  • tslib will be longer be added as a dependencies, but rather it will be added as a peerDependencies.

This is to be inline with the Angular framework as per

Bug Fixes

  • downlevel constructor parameters transformer with tsickle (51d5498), closes #1517
  • add assets option to schema (a5efd1c), closes #1092
  • add link to Angular guide when showing ivy publish warning (6bee029), closes #1453
  • add more package json sections to remove (57cc4d1)
  • analyse only non done entry points (e8db885)
  • analyse should cater for module name being the primary entry point (7b8e491)
  • circular dependency on itself error (702c3f2), closes #1508
  • ignore .gitkeep, Thumbs.db and .DS_Store when copying files (a5b10e2)
  • ignore JSON files in tsickle processing (#1489) (ec44059), closes #325
  • incorrect detection of potential dependent entry-points (932bf48), closes #1510
  • lock rollup version (75ac180), closes #1431
  • remove redundant section in package.json (5efad3a)
  • reset glob cache on file add (0306d59)
  • skip NGCC when file system is read only (0e44793)
  • switch to a more accurate module analyse (92ca053), closes #1523
  • update commander to version ^4.0.0 (ee41977)
  • update rollup to version 1.31.0 (f8704fd)
  • update update-notifier to version ^4.0.0 (f05cbbf)

Features

  • add support for TypeScript 3.7 (9e05fb3)
  • add support for TypeScript 3.6 (342b799)
  • add tslib as peerDepedency (5077f87)
  • update peerDependencies (7ff60f5)

Performance

  • re-populate glob cache (3323b2a)
  • remove less-plugin-npm-import (6a5ae37)

9.0.0-rc.9 (2020-02-05)

9.0.0-rc.8 (2020-02-04)

Bug Fixes

  • downlevel constructor parameters transformer with tsickle (51d5498), closes #1517
  • analyse only non done entry points (e8db885)
  • analyse should cater for module name being the primary entry point (7b8e491)
  • circular dependency on itself error (702c3f2), closes #1508
  • ignore .gitkeep, Thumbs.db and .DS_Store when copying files (a5b10e2)
  • incorrect detection of potential dependent entry-points (932bf48), closes #1510
  • reset glob cache on file add (0306d59)
  • switch to a more accurate module analyse (92ca053), closes #1523
  • update rollup to version 1.31.0 (f8704fd)
  • update update-notifier to version ^4.0.0 (f05cbbf)

Features

  • add support for typescript 3.7 (9e05fb3)

Performance

9.0.0-rc.7 (2020-01-09)

Bug Fixes

  • circular dependency on itself error (702c3f2), closes #1508

9.0.0-rc.6 (2020-01-09)

Bug Fixes

  • analyse only non done entry points (e8db885)
  • reset glob cache on file add (0306d59)

Performance

9.0.0-rc.5 (2020-01-08)

Bug Fixes

  • update rollup to version 1.29.0 (04fa486)

Performance

  • use TypeScript scanner to build dependency tree (1cdc8c8)

9.0.0-rc.4 (2020-01-07)

Bug Fixes

  • ignore .gitkeep, Thumbs.db and .DS_Store when copying files (a5b10e2)
  • update rollup to version 1.28.0 (624f31f)
  • update update-notifier to version ^4.0.0 (f05cbbf)

9.0.0-rc.3 (2019-12-04)

Bug Fixes

  • add assets option to schema (a5efd1c), closes #1092
  • add link to Angular guide when showing ivy publish warning (6bee029), closes #1453

9.0.0-rc.2 (2019-11-14)

Bug Fixes

  • add more package json sections to remove (57cc4d1)
  • remove redundant section in package.json (5efad3a)
  • skip NGCC when file system is read only (0e44793)
  • update commander to version ^4.0.0 (ee41977)
  • update rollup to version 1.26.2 (8e91477)
  • update rollup to version 1.26.3 (1a67c7c)
  • update rollup to version 1.26.4 (844f7d3)
  • update rollup to version 1.26.5 (cb5bda7)

9.0.0-rc.1 (2019-10-29)

⚠ BREAKING CHANGES

  • Remove usage of deprecated less-plugin-npm-import. In less v3 is supports node_modules resolutions by default.

Before

@import '~module/less/linenumbers';

After

@import 'module/less/linenumbers';

Bug Fixes

  • remove less-plugin-npm-import (6a5ae37)

9.0.0-rc.0 (2019-10-22)

⚠ BREAKING CHANGES

  • TypeScript versions prior to 3.6.4 are no longer supported.
  • tslib will be longer be added as a dependencies, but rather it will be added as a peerDependencies. This is to be inline with the Angular framework.

Features

  • add support to TypeScript 3.6 (342b799)
  • add tslib as peerDepedency (5077f87)
  • update peerDependencies (7ff60f5)

5.7.0 (2019-10-15)

Bug Fixes

Features

  • deprecate inlining of bundledDependencies (0c52486)

5.6.1 (2019-10-09)

Bug Fixes

  • tsickle references to non imported values when using Angular 8 (de5894b)

5.6.0 (2019-10-08)

Bug Fixes

  • disable internal emitDecoratorMetadata (d0bf507)
  • support the ng-package.json in secondary entry points (#1406) (8b97bfa)
  • update @angular/cdk to version ~8.2.0 (0007fef)

Build System

  • update @angular-devkit/build-angular to version ~0.803.0 (194c6bb)
  • update cross-env to version ^6.0.0 (120331a)
  • update jasmine-core to version ~3.5.0 (#1404) (aeabd95)
  • update ts-node to version ~8.4.0 (9a4dddc)
  • update tslint to version ~5.20.0 (4e4b1d5)
  • update zone.js to version ^0.10.0 (88f8cb4)

Features

  • copies CHANGELOG.md to package destination (db5ad68)

Tests

  • update angular cli dev packages (3e26f7b)

5.5.1 (2019-09-14)

Bug Fixes

  • add downlevelConstructorParameters transformer (b959010), closes #1400
  • remove terser warnings as these as not actionable (9c80f62), closes #1394
  • update rimraf to version ^3.0.0 (9236102)

5.5.0 (2019-08-14)

Bug Fixes

  • disable treeshaking when generating bundles (34b26fc)
  • update commander to version ^3.0.0 (dcd4853)

Features

  • disable Ivy in default tsconfig (f50dd2f)
  • show error when trying to publish ivy packages (c3122d6)

5.4.3 (2019-07-29)

Bug Fixes

  • handle svg templates same as html files (2156f5f)

5.4.2 (2019-07-29)

Bug Fixes

  • handle deep undefined in schema options (02055d0), closes #1356

5.4.1 (2019-07-29)

Bug Fixes

  • remove defaults from languageLevel (7650c65)

5.4.0 (2019-07-29)

Features

  • add support for Ivy libraries (b6dfcf6)
  • add support for typescript 3.5 and Angular 8.X pre-releases (798de61)
  • use ajv to validate schema (e5e9864)

5.3.0 (2019-06-05)

Bug Fixes

  • add quotes to less include-path (af6816b)
  • don't write stacktraces when there are errors (42692b0)
  • remove opencollective postinstall scripts (123f39a)
  • update terser to version ^4.0.0 (dd28818)

Features

5.2.0 (2019-05-17)

Bug Fixes

  • copy+dereference LICENSE and README.md (6ace017)
  • fix resolution for less binary (6bc789c), closes #1276
  • logger print errors and warnings to stderr (9534d19)
  • update chokidar to version ^3.0.0 (2f0e75f)
  • update fs-extra to version ^8.0.0 (de09a1a)
  • update update-notifier to version ^3.0.0 (d5b136f)

Features

  • update several rollup dependencies (0772371)

5.1.0 (2019-04-15)

Bug Fixes

  • emit ts option diagnostic (ed960b6)
  • error out gracefully when package.json is not found (902dea2), closes #1255

Features

  • add support for TypeScript 3.4 (828065c)

5.0.1 (2019-03-27)

Bug Fixes

  • version command should not require tsickle (6ac0dcf)

5.0.0 (2019-03-27)

Bug Fixes

  • update core-js to version ^3.0.0 (b985c49)
  • update read-pkg-up to version ^5.0.0 (cb172fa)
  • update rollup-plugin-json to version ^4.0.0 (8d4d4a7)

Features

  • add node-sass support with sass as default (43a0be6)
  • add support for Angular 8 and TypeScript 3.3 (dfe5a27)
  • remove tsickle from direct peerDepedencies (1555cf6), closes #1202
  • replace uglify-js with terser (a18d7ad)
  • update rollup to version 1.6+ (82f97e4), closes #1227

Performance Improvements

  • generate umd bundle directly from fesm5 instead of esm5 (b25731b)
  • reduce the amount of dependees that are removed (408541e)

BREAKING CHANGES

  • Users outside of Google don't usually need closure annotations hence annotateForClosureCompiler is turned off by default. In case users want to emit closure compatible code, they need to install tsickle and enable opt it this feature.

  • We no longer use node-sass by default, instead we use sass (dart-sass).

While in most cases this should not have an impact the generated code, dart sass has some differences from Ruby Sass. See https://github.com/sass/dart-sass#behavioral-differences-from-ruby-sass for more details

If you wish to use node-sass instead of sass you need to install node-sass as a dev dependency.

npm users

npm install node-sass --save-dev

yarn users

yarn add node-sass --dev

4.7.1 (2019-02-15)

Bug Fixes

  • don't use classic module resolution during analyse (f0a1c38), closes #1210
  • emit complete diagnostics (82e1fd0)
  • replace opencollective-cli with opencollective-postinstall (#1203) (44776da), closes #1178

4.7.0 (2019-01-26)

Bug Fixes

  • read error when having files with spaces in less (22cfdcc), closes #1197
  • use old TypeScript API to support users which are still on 2.7.x+ (eec8b84), closes #1186
  • use ts.compilerHost as moduleResolutionHost for tsickle.emitWithTsickle to support tsickle 0.33.1 (30d3720), closes #1189

Features

  • add support for tsickle to 0.34.0 (3b67d90)

Performance Improvements

  • simplify Node dependsOn logic (4a0585d)

4.6.0 (2019-01-15)

Bug Fixes

  • add opencollective postinstall hook (c3dbaeb)
  • analyses of secondary entrypoints doesn't work with deep imports (3f56df2), closes #1183

4.5.0 (2019-01-11)

Bug Fixes

  • update rollup-plugin-node-resolve to version ^4.0.0 (ab2a55a)

Features

  • add support for TypeScript 3.2 (9e6ee67)

Performance Improvements

  • cache ng program for faster incremental builds (4131d4c)
  • improve entry points analyses (bcc7f05)

4.4.5 (2018-12-01)

4.4.4 (2018-12-01)

4.4.3 (2018-12-01)

4.4.2 (2018-12-01)

Bug Fixes

  • add opencollective postinstall hook (c3dbaeb)

4.4.1 (2018-11-07)

Bug Fixes

  • ignore git folder on watch (c61cbfc)
  • UMD sourceMappingURL should point to file (ab02f0f)
  • update rollup to version ^0.67.0 (4422aa1)

4.4.0 (2018-10-21)

Features

4.3.1 (2018-10-14)

Bug Fixes

  • update templates and styles in watch mode (bfc019f)

4.3.0 (2018-10-09)

Bug Fixes

  • JavaScript heap out of memory when having a lot of secondary entrypoints (ca3d1d3), closes #1099
  • tsconfig path mapping (4421e6f)

Features

  • add support for TypeScript 3.1 (c354261)

4.2.0 (2018-09-18)

Bug Fixes

  • update rollup to version ^0.65.0 (03db010)
  • update rollup to version ^0.66.0 (3d381b0)

Features

  • add and version as peerDependencies (97c5fec)
  • add TypeScript version 3 as a peerDependency (5f0b761)
  • add a option to pass a custom tsconfig in CLI (cb6a980)

4.1.1 (2018-08-26)

Bug Fixes

  • allow sass indexed syntax to be compiled (+ integration tests) (#1053) (34a259d)

4.1.0 (2018-08-12)

Bug Fixes

Features

Performance Improvements

4.0.1 (2018-07-26)

Bug Fixes

  • add enableResourceInlining by default to tsconfig (#1021) (d2e9678), closes #976

Performance Improvements

  • analyse sources only for dirty entrypoints (#1017) (191cf00)

4.0.0 (2018-07-22)

Bug Fixes

Features

  • build only entrypoints that are effected by the change (#991) (1f79aa2), closes #974

4.0.0-rc.4 (2018-07-17)

Bug Fixes

4.0.0-rc.3 (2018-06-29)

Bug Fixes

Features

  • add watch and buildAsObservable methods (#982) (6975192)
  • update lib compiler option to es2018 (#956) (6bbedee)

Performance Improvements

BREAKING CHANGES

  • The following peerDependencies are now required
  • tslib: ^1.9.0
  • typescript: ^2.7.0

4.0.0-rc.2 (2018-06-23)

Bug Fixes

  • update read-pkg-up to version ^4.0.0 (#955) (c07e888)

Features

Performance Improvements

  • don't scan node_modules directory while globbing (#949) (ee7b892), closes #948

4.0.0-rc.1 (2018-06-12)

Bug Fixes

Performance Improvements

  • speed up discovery of secondary entry points (#930) (d646721), closes #921

4.0.0-rc.0 (2018-05-25)

Bug Fixes

Features

  • embed templates and stylesheets with ngc enableResourceInlining (#872) (2655def), closes #770

BREAKING CHANGES

  • ng-packagr now requires a peerDependency of @angular/compiler: ^6.0.0 and @angular/compiler-cli: ^6.0.0. Removes support for building packages with Angular compiler v5.
  • Consumers using a custom tsconfig via the programmatic API need to add enableResourceInlining under angularCompilerOptions

3.0.0 (2018-05-25)

Bug Fixes

  • allow sideEffects to be set as an array (#866) (04bb2ad)
  • analyse exported imports (#873) (c03d6f8)
  • auto-wire paths for transitive dependencies of entry points (#875) (e9da0cf), closes #852
  • embed tslib helpers in umd bundle (#868) (0fc30e5)
  • internal method dependsOn appends instead of replacing (#867) (207f2ac)
  • remove duplicate declarations under dist (#864) (46fd858)
  • throw an error when a circular dependency is detected (#888) (ada4081), closes #855
  • update rollup to version ^0.59.0 (#876) (57f5ed9)

Features

Performance Improvements

  • remove extra template type checking for downleveling (#863) (0e0e46d)

BREAKING CHANGES

  • UMD module ids for rxjs v5 are now longer provided out-ot-the-box. Users whishing to a build library for rxjs@5 (potentially relying on rxjs-compat), must provide the UMD module IDs in the ngPackage.lib.umdModuleIds section. Please take a look at the changeset of PR #840 to see what the UMD module IDs used to be for v5.

3.0.0-rc.5 (2018-05-11)

Bug Fixes

BREAKING CHANGES

  • baseUrl in tsconfig is not overridden anymore, thus non-relative module paths will be resolved relative to the baseUrl in tsconfig.json

3.0.0-rc.4 (2018-05-10)

Bug Fixes

  • add missing 'declaration' option in tsconfig (#790) (dbd8ce1)
  • correct depth analysis of unordered dependencies for secondaries (#846) (f4beea9)
  • create an array large enough to hold all buckets (#845) (353b0fa)
  • handle nested entry points with same name (#850) (f911882), closes #851 #849
  • inline sourcemaps as base64-encoded data URI in esm5/esm015 (#812) (095feb1), closes #785 #803

3.0.0-rc.3 (2018-05-06)

Bug Fixes

  • let ngc determine the typescript emitFlags (#813) (9b47d72)
  • migrate code base to compiler-cli@6 (927e581)
  • migrate dependencies to angular 6 (13917eb)
  • remove nested dist folder (#829) (f9af7ca)
  • unpin rollup-plugin-commonjs to version ^9.1.3 (#823) (17f791f)
  • update fs-extra to version ^6.0.0 (#825) (2aabd33)
  • update rollup to version ^0.58.0 (#772) (cfcf3f9)
  • update rollup-plugin-commonjs to version ^9.1.2 (#819) (1731968)
  • update rxjs to version ~6.0.0 (b171a28)
  • update rxjs to version ~6.1.0 (#832) (365c759)

Features

3.0.0-rc.2 (2018-04-21)

Bug Fixes

  • add moduleResolution to downleveling options (#787) (d7b4094), closes #784
  • generate correct UMD module id for [@angular](https://github.com/angular)/common/http/testing (#782) (a0451d8)
  • missing options when setting custom tsconfig (#786) (d687853)
  • update rollup-plugin-commonjs to version 9.1.0 (#659) (5204b0c)

3.0.0-rc.1 (2018-04-17)

Features

  • add "sideEffects": false flag to dist-ready package.json (#776) (11535bb)

3.0.0-rc.0 (2018-04-16)

Bug Fixes

Features

  • build libaries in Angular Package Format (APF) v6.0 (#738) (4e6c4f4), closes #738 #705
  • drop support for node v6 and v7 (no longer supported by devkit) (ee7e65d)
  • remove deprecated code (#773) (866a4b5)
  • update tsickle to =>0.27.3, rollup to ^0.57.1 (#769) (3bcf233), closes #679

BREAKING CHANGES

Removes several deprecated code items.

  • option sassIncludePaths is removed, please use styleIncludePaths instead
  • option workingDirectory is removed, removed corresponding getter from NgPackage class
  • method createNgPackage removed from programmatic API
  • removed NgArtefacts class from API
  • removed BuildStep interface from API
  • removed tarball generation (#721)

There were some important changes, mainly related to rollup, most of the options and functionality provided by rollup plugins (comments & license) have been removed, due to the fact this is not inline with APF V6 as one will end up with different outputs in different modules.

  • comments option has been removed
  • licensePath option has been removed

In APF V6, it is recommanded to not embed dependencies due to the fact that it will end up having multiple copies of the same library in a single application.

  • embedded option has been removed and the original functionality was dropped as it increased the chance of having 2 copies of the same library. The recommended migration is to switch to bundledDependencies

More info in the APF v6 spec: https://docs.google.com/document/d/1CZC2rcpxffTDfRDs6p1cfbmKNLA6x5O-NtkJglDaBVs/preview

Documentation on npm bundled dependencies: http://npm.github.io/using-pkgs-docs/package-json/types/bundleddependencies.html

Tarball generation

As we don't generate a tarball by default anymore, you should manually, after the build, create it by running npm pack in the dist folder of your library. See #802 and #738 (comment) for more information.

2.4.2 (2018-04-08)

Bug Fixes

2.4.1 (2018-03-25)

Bug Fixes

  • don't verify devDependencies in dist-ready package.json (#721) (3535e86)

2.4.0 (2018-03-25)

Features

  • create a tarball (dist.tgz) for the npm package (#715) (94bc915)

Performance Improvements

  • read content and map async in minifyJsFile (#717) (4da0052)

2.3.0 (2018-03-25)

Bug Fixes

  • cannot read property 'text' of undefined (#669) (b91eb66), closes #668
  • move keepLifecycleScripts to ngPackage conf (#688) (8eb6667)
  • validate non-peerDependencies at build time (#687) (ec9779c)

Features

  • add support for AMD module id in umd bundles (#675) (59713b8)
  • allow Angular 6 as a peer dependency (#714) (530d54e)
  • allow to override umd module identifier (#683) (b6e099f)
  • remove scripts section in dist-ready package.json (#686) (810e58a)
  • support intra-package dependencies (re. entry points, experimental) (#685) (988968e)

2.2.0 (2018-03-06)

Bug Fixes

  • add chalk to dependencies (#647) (e8aa93f)
  • lock rollup-plugin-commonjs dependency at 8.3.0 (#658) (59d0c3b), closes #657
  • update rollup-plugin-license to version ^0.6.0 (#664) (2a21d7e)

Features

Performance Improvements

  • re-use postcss processor instance per entry point (#645) (f70985b)

2.1.0 (2018-02-21)

Bug Fixes

  • pass 'setParentNodes' when calling 'createCompilerHost' (#625) (9baa0bc)
  • prune multiple import statements for tslib (#588) (2b6dac4), closes #587
  • recognize aliased and namespace decorator imports (#585) (8f88c5a)
  • return redirect target of typescript source file (#637) (c1fced0), closes #473

Features

  • styleIncludePaths for feature parity with Angular CLI (#603) (ab973f4), closes #282
  • comments cleanup and license header file (#574) (0237f24), closes #362
  • export and test public api surface (#584) (6858e2e)

2.0.0 (2018-02-05)

Version 2 of ng-packagr is targeting Angular 5 (and beyond). Update your projects by:

$ yarn add --dev ng-packagr@^2.0.0 @angular/compiler@^5.0.0 @angular/compiler-cli@^5.0.0 tsickle

Migrating from v1 (Breaking changes from v1.6.0 to v2.0.0)

  • Users now need to install @angular/compiler, @angular/compiler-cli, typescript, and tsickle to the devDependency section of their project (if not already installed). ng-packagr uses both the TypeScript and the Angular compiler version provided by the user workspace.
  • The setting for external dependencies (lib.externals) has been removed in favour of lib.umdModuleIds which is now just used to provide the UMD module identifiers of external dependencies. By default, all dependencies are now treated as externals and thus are not embedded in the final bundle. If a dependency should be embedded in the distributables, it needs to be explicity added to lib.embedded. Please consult the updated README on migrating your package confguration from lib.externals to lib.umdModuleIds and lib.embedded.
  • Discovery of primary and secondary entry points is changed to read from the following file sources. File locations are tried in this order:
    • package.json with ngPackage property
    • ng-package.json (requires a package.json as sibling)
    • ng-package.js (with a default export, requires a package.json as sibling)
  • Setting ngPackage.src has no effect any more. The source directory (base path) is equivalent to the location of the (primary) ng-package.json, package.json, or ng-package.js.
  • UMD Module IDs of packages have been changed: when you published a scoped npm package, e.g. @sample/core, the UMD module ID used to be core including only the second part of the npm package name. With this change, the UMD module ID is now sample.core. For secondary entrypoints, e.g. @sample/core/testing, the UMD module ID now also includes every part of the npm package name, e.g. sample.core.testing. Publishing your npm packages built with this version of ng-packagr causes a new UMD module ID to be generated. Users of your library need to update their configuration, e.g. when using SystemJS!

An excerpt of each bug fix and feature is listed below for the respective release candidate version!

Bug Fixes

  • recognize aliased and namespace decorator imports (#585) (8f88c5a)

Features

2.0.0-rc.13 (2018-02-03)

Bug Fixes

  • add postcss-discard-comments as a dependency (#544) (bce5705), closes #543
  • css comments should be discarded irrespective of cssUrl (#562) (d6eb971)
  • embed tslib helpers in UMD bundles only (#573) (7a996ef), closes #371
  • map rxjs/util/* to its UMD module ID by default (#580) (7c452fb), closes #579
  • pin rollup dependency to 0.53.0 (13a79d4)
  • report build errors (d136422)
  • strip bom from templates and stylesheet files (#571) (5830e6a), closes #487
  • update rollup to version ^0.55.0 (#534) (0cb0cce), closes #488 #523
  • write type definition files (via triple-slash reference) to npm package (#443) (9dad573)

Features

  • expand api to .withTsConfig(string|TsConfig), .forProject() (#561) (48f3569), closes #557
  • le jardin, a broccoli-inspired rewrite (#572) (6efc2d2)

Performance Improvements

2.0.0-rc.12 (2018-01-25)

Bug Fixes

  • dispose the previous TransformationResult after inlining (#533) (b4c7e89)
  • strip comments from processed styles (#512) (542aed2), closes #503

Features

  • enable tsconfig customization thru the programmatic API (#517) (8b04d44), closes #256

2.0.0-rc.11 (2018-01-17)

Bug Fixes

  • escape unicode characters in css with a double blackslash (#453) (9891128), closes #425

Features

  • add language level support for library authors (#486) (b33e0bc)
  • enable custom sassIncludePaths for resolving scss imports (#494) (f8e8dc5)

2.0.0-rc.10 (2018-01-10)

Bug Fixes

  • exclude ng-package.json from entry point discovery (#471) (38103ac), closes #463
  • relax version constraints, enable TypeScript 2.6 (w/ tsickle ^0.26.0) (3c3c6a7)
  • update dependendy tsickle to >=0.25.5 <0.26.0 (#456) (136867a), closes #452

Features

  • stabilize command API, move towards customizing through DI (#470) (f992283)
  • turn on downlevelIteration flag for ES5 bundles (#475) (616888a), closes #418

2.0.0-rc.9 (2017-12-30)

Bug Fixes

  • supports extracting styles from multiple styleUrls (#455) (4cfd98d)

2.0.0-rc.8 (2017-12-26)

Bug Fixes

  • remove umdModuleIds for esm2015 flattening (rollup es format) (#429) (b103b74)
  • remove moduleId from rollup bundle options (#444) (da332d2)
  • update rollup to version ^0.53.0 (#438) (8918809)

Features

  • dynamic rollup configuration for esm flattening (#395) (5712429)
  • expose build and version commands from public API (#447) (286819c)
  • expose a public API surface for programmatic usage (ec2b29f)
  • remove src property from package schema (#431) (960484c)

BREAKING CHANGES

  • Setting ngPackage.src has no effect any more. The source directory (base path) is equivalent to the location of the (primary) ng-package.json, package.json, or ng-package.js.
  • lib.externals has been removed in favour of lib.umdModuleIds which is now just used to provide the UMD module identifiers of external dependencies. By default, all dependencies are now treated as externals and thus are not embedded in the final bundle. If a dependency should be embedded in the distributables, it needs to be explicity added to lib.embedded. Please consult the updated README on migrating your package confguration from lib.externals to lib.umdModuleIds and lib.embedded.

2.0.0-rc.7 (2017-12-15)

Bug Fixes

  • log error message only on build failure (51643e1)
  • print @angular/compiler-cli version (b0e362e)
  • print rollup warnings to log.warn() (356a01b)
  • relax on non-call-expression decorators in typescript parsing (7135c42)
  • set peerDependencies to tsickle: ^0.24.0 and typescript: >=2.4.2 <2.6 (#387) (001f63f)
  • set peerDependency tsickle: >=0.24.0 <0.26 (d682cd2)
  • update fs-extra to version ^5.0.0 (#400) (9e6d081)

Features

  • discover entry points from user packages (#383) (4a7e96e), closes #190
  • do not prune working directory on build failure (6445316)
  • provide version info with ng-packagr --version cli option (#393) (758c403)

Performance Improvements

  • read set of typescript source files only once (#388) (bbbbd27)

BREAKING CHANGES

  • Discovery of primary and secondary entry points is changed to read from the following file sources. File locations are tried in this order:

  • package.json with ngPackage property

  • ng-package.json (requires a package.json as sibling)
  • ng-package.js (with a default export, requires a package.json as sibling)

2.0.0-rc.6 (2017-12-09)

Bug fixes for the previous release candidate.

Contains a fix addressing typescript build errors due to synthesized nodes, see #369.

Peer Dependencies on ngc and tsc changed to caret version ranges:

  • "@angular/compiler: "^5.0.0"
  • "typescript: ">= 2.4.2 < 2.6

Make sure to use an appropriate combination of Angular and TypeScript!

Bug Fixes

  • peer depend on angular >=5.0.0 <6.0.0, typescript >= 2.4.2 < 2.6 (3674f0e)
  • register ngc emit callback for tsickle processing (#384) (15bd7c1)
  • show proper path of failure on sass inline (#380) (8c380aa)

Features

  • add option cssUrl, inline css url:() to data: URIs (#345) (1c71f24), closes #263

2.0.0-rc.5 (2017-12-06)

Bug Fixes

Features

  • consistent flatModuleFile naming for bundles (#361) (17b4e0f)
  • enable tslib importHelpers, reducing bundle sizes (#338) (f1e4cf6)
  • expose programmatic API and typings (#342) (61c7b50)
  • implement transformSources() w/ domain model (#356) (89ce2ce)
  • relocate source map file paths to ng://<(at)org>/<package>/<sub> (#332) (c9b8d73)
  • resolve "~" scss import statements to nearest node_modules (#352) (ee9800b), closes #346
  • resource inlining w/ TypeScript transformations (#279) (4753066)

BREAKING CHANGES

  • Introduces a domain model for Package and Entry Point (as defined in Angular Package Format Specification Glossary). Refactors the source code transformation pipeline. Albeit the refactoring was undertaken with care and integration tests were not changed, it may cause undesired behaviour.

2.0.0-rc.4 (2017-11-28)

Bug Fixes

  • bump commander to ^2.12.0, optimize typings for cpx and commander (#323) (68d0c34)

Features

2.0.0-rc.3 (2017-11-24)

Bug Fixes

  • support new cdk modules 'accordion' and 'layout' @angular/cdk@5.0.0-rc0 (#297) (3016585)
  • support rxjs lettable operators (#307) (5de8045), closes #247

2.0.0-rc.2 (2017-11-17)

2.0.0-rc.1 (2017-11-17)

Bug Fixes

  • report ngc compiler diagnostics and throw an error (#292) (815509b)

Features

  • add rxjs mapTo operator to rollup globals (#293) (1a42ce1)

2.0.0-rc.0 (2017-11-14)

Migrating towards Angular v5, a series of v2.0.0 release candidates will be published. These releases will be published using the next tag on npm. Please install the versions with "ng-packagr: "^2.0.0-rc.0" or yarn add --dev ng-packagr@next.

The v2.0.0 release candidates collect several breaking changes compared to the last v1.x.

Bug Fixes

  • include scope name in module name of Rollup bundle (#280) (3446453), closes #251

Features

  • invoke ngc thru @angular/compiler-cli version 5.0.x (c5c32c5), closes #219
  • update typescript to ~2.4.2 for Angular v5 support (#270) (2c6db4f)

BREAKING CHANGES

  • when you published a scoped npm package, e.g. @sample/core, the UMD module ID used to be core including only the second part of the npm package name. With this change, the UMD module ID is now sample.core. For secondary entrypoints, e.g. @sample/core/testing, the UMD module ID now also includes every part of the npm package name, e.g. sample.core.testing. Publishing your npm packages built with this version of ng-packagr causes a new UMD module ID to be generated. Users of your library need to update their configuration, e.g. when using SystemJS!
  • Users now need to install @angular/compiler and @angular/compiler-cli to the devDependency section of their project (if not already installed). ng-packagr uses both the TypeScript and the Angular compiler version provided by the user workspace.

1.6.0 (2017-11-14)

This release rolls back premature Angular v5 support in v1.6.0-rc.0. It is recommended to use this version of ng-packagr for building Angular v4 libraries, as typescript in 2.3.x and @angular/tsc-wrapped in 4.4.x are used.

Libraries generated with this version of ng-packagr will ship with AoT metadata in version 3, which is intended for Angular v4.

Bug Fixes

Features

1.5.2 (2017-11-14)

This release reverts a regression introduced in v1.5.1. See pull request #268.

Previously, a user of ng-packagr could install an incompatible typescript version for ng-packagr. Prevent inadvertent typescript installs by depending on a user's typescript installation (peerDependencies). This should be (is a) non-breaking change as any Angular project requires typescript as devDependency.

Bug Fixes

  • depend on user's typescript (8f5bb9c)

1.6.0-rc.0 (2017-11-10)

Bug Fixes

Features

  • add tsx/jsx support (#228) (4068664)
  • invoke ngc thru @angular/compiler-cli version 5.0.x (#271) (c5c32c5), closes #219
  • update typescript to ~2.4.2 for Angular v5 support (#270) (2c6db4f)

1.5.1 (2017-11-10)

Bug Fixes

  • depend on user's typescript and tsc-wrapped (#268) (42b2f08)

1.5.0 (2017-11-05)

Secondary entrypoints – such as @angular/core/testing, @angular/common/http, @angular/cdk/a11y, et al. – can now be bundled with ng-packagr. Angular's tsc-wrapped is now version ^4.4.5 and typescript is ^2.3.4 – whether these work well with Angular 5 needs to be verified.

Bug Fixes

  • add description for ngPackage property in package.json (3f8e25c)
  • copy README.md and LICENSE just for primary entry (#215)(38776d8)
  • validate ngPackage property for secondary entry resolution (#229) (ee5949b)
  • resolve node_modules folder dynamically from typescript (#211) (9a7008d)
  • produce correct secondary package paths (#197) (4ca213e)
  • respect secondary entry file customizations (#198) (9de7524)
  • regression in cli defaults (18515af)

Features

BREAKING CHANGES

  • for auto-discovery of secondary entries, package.json files are now validated whether a ngPackage property exists; the value can be an empty object. This is a breaking change for a feature introduced in release candidate versions 1.5.0-rc.0/1.5.0-rc.1. When upgrading from 1.4.x to 1.5.0, it is not-breaking.

1.5.0-rc.1 (2017-10-23)

Bug Fixes

  • produce correct secondary package paths (#197) (4ca213e)
  • respect secondary entry file customizations (#198) (9de7524)

Features

1.5.0-rc.0 (2017-10-18)

Bug Fixes

  • regression in cli defaults (18515af)

Features

  • allow empty package.json for 2ndary entries (c0af605)
  • dynamic secondary entry points (5922cb1)
  • help command on cli (c68a190)

1.4.1 (2017-10-11)

Bug Fixes

  • include package.schema.json in dist artefacts and npm package (e660545)

1.4.0 (2017-10-10)

Bug Fixes

  • pass empty string to less.render() (f5106eb), closes #165

Features

  • add json schema for package.json with custom ngPackage property (#173) (dd85fd2)
  • resolve ng-package config from multiple sources (c193b68)

1.3.0 (2017-10-04)

Features

  • external dependencies from [@angular](https://github.com/angular)/cdk are supported by default (4b20e29)

1.2.1 (2017-09-29)

Bug Fixes

1.2.0 (2017-09-20)

Features

  • add rollup commonjs plugin to support all library types (#121) (3f87f5e)
  • update rollup to version 0.50.0 (#124) (fb9f529)

1.1.0 (2017-09-12)

Features

1.0.1 (2017-08-31)

Bug Fixes

  • make a dummy release for 1.0.1 (a6d6893)

1.0.0 (2017-08-31)

Features

  • ng-packagr is released 1.0.0 final (665a249)

1.0.0-pre.17 (2017-08-28)

Bug Fixes

  • package: update rollup to version 0.49.0 (b5b920c)

Features

1.0.0-pre.16 (2017-08-22)

Features

  • update rollup to version ^0.48.0 (9110899)

1.0.0-pre.15 (2017-08-16)

Bug Fixes

  • move ng-package.schema.json to dist root directory (ad6325b)
  • read json config values thru schema.$$get() (0c3130c)

Features

  • update rollup to version 0.46.0 (1f25f7a)
  • update rollup to version 0.47.0 (29a8901)

BREAKING CHANGES

  • the ng-package.schema.json was accidentally moved to lib folder in a previous release. Restore it in its original location!

1.0.0-pre.14 (2017-08-07)

Bug Fixes

  • add 'let' to known rxjs operators (9927f93), closes #85
  • move less from devDependencies to dependencies (09ef8ce), closes #88
  • strip utf-8 bom when reading files (cb34889), closes #87

1.0.0-pre.13 (2017-07-28)

Features

  • support rxjs operators with different import syntaxes (#82) (d64aa40)

1.0.0-pre.12 (2017-07-27)

Features

1.0.0-pre.11 (2017-07-22)

Bug Fixes

  • pass file pathes to postcss.process() (#77) (1051831)

1.0.0-pre.10 (2017-07-14)

Bug Fixes

  • correct explanation of lib.flatModuleFile (d95afb0)

Features

  • remove node 4.x support (7a857d4)

1.0.0-pre.9 (2017-07-11)

Bug Fixes

  • use pkg name for es modules folder name when @<scope> is undefined (#70) (cf24b1b)

1.0.0-pre.8 (2017-07-11)

Features

  • import scss files with "~" syntax from node_modules (#67) (205bbc0)
  • update rollup to version ^0.45.0 (#69) (d124cb3), closes #68

1.0.0-pre.7 (2017-07-04)

Features

  • exclude node_modules from being copied to working dir (#60) (6bfe713), closes #51
  • version bump rollup to ^0.43.0 (227e3b7)

1.0.0-pre.6 (2017-06-24)

Features

1.0.0-pre.5 (2017-06-23)

Features

1.0.0-pre.4 (2017-06-08)

Bug Fixes

  • correct paths in generated sourcemaps (#50) (c389160), closes #46
  • temporarily disable es5 source maps (804dd8c)

1.0.0-pre.3 (2017-06-06)

1.0.0-pre.2 (2017-06-06)

Bug Fixes

  • package: update rollup to version 0.42.0 (#37) (75f1811)
  • add rxjs/ReplaySubject to rollup defaults (#44) (237b24e)

1.0.0-pre.1 (2017-06-02)

Bug Fixes

  • report Errors with stack traces, fail builds on promise rejection (#36) (6076074)

1.0.0-pre.0 (2017-06-02)

Features

  • use '1.0.0-pre.n' version number for any upcoming prerelease (a31c824)

1.0.0-alpha.7 (2017-06-02)

Bug Fixes

  • correctly locate typings file (3d5c266)
  • set flatModuleId to the name from package.json (#24) (1e2c33f)

Features

  • remove deprecated ng-package.json properties (9b988b0)

1.0.0-alpha.6 (2017-06-02)

1.0.0-alpha.5 (2017-06-02)

Bug Fixes

  • correctly locate typings file (3d5c266)
  • set flatModuleId to the name from package.json (#24) (1e2c33f)

1.0.0-alpha.4 (2017-06-02)

Bug Fixes

  • correctly locate typings file (3d5c266)
  • set flatModuleId to the name from package.json (#24) (1e2c33f)

1.0.0-alpha.3 (2017-05-31)

Features

  • implement build steps with updated ng-package.json (259a9fc)
  • include [@angular](https://github.com/angular)/router in default rollup opts (3d576ee)
  • JSON schema for ng-package.json (76dd2ff)

1.0.0-alpha.2 (2017-05-27)

Features

  • default config file ng-package.json (#10) (00fa15c)

BREAKING CHANGES

  • the default config file is renamed from .ng-packagr.json to ng-package.json. Use one ng-package.json per each Angular library project.

1.0.0-alpha.1 (2017-05-27)

Bug Fixes

  • resolve pathes relative to ng-package.json (852ce43)

Features

  • @angular and rxjs rollup globals (58702e3)
  • each Angular package is reflected in one ng-package.json file (#8) (b8d0649)

1.0.0-alpha.0 (2017-05-19)

Features

  • cli command ng-packagr for npm script users (6d4a90e)
  • configuratin with .ng-packagr.json file (c1762b3)
  • demo library (2cb2066)
  • implement ng-packagr (8474e36)
  • Initial proof-of-concept compilation (91880b9)
  • produce source maps in Angular Package (bc84b54)