Compile and package Angular libraries in Angular Package Format (APF)
npm install ng-packagr> Compile and package Angular libraries in Angular Package Format (APF)
``bash`
npm install -D ng-packagr
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 ng-package.json file and run ng-packagr -p ng-package.json
– Here we go:
`json`
{
"$schema": "./node_modules/ng-packagr/ng-package.schema.json",
...
}
You can easily run _ng-packagr_ through a npm/yarn script:
`json`
{
"scripts": {
"build": "ng-packagr -p ng-package.json"
}
}
Now, execute the build with the following command:
`bash`
$ yarn build
The build output is written to the dist folder, containing all those _binaries_ to meet the Angular Package Format specification.npm publish dist
You'll now be able to go ahead and 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!
* :gift: Implements Angular Package Format
* :checkered_flag: Bundles your library in FESM2022
* :school_satchel: npm package can be consumed by Angular CLI, Webpack, or ESM Bundlers
* :dancer: Creates type definitions (.d.ts`)
* :mag_right: Creates scoped and non-scoped packages for publishing to npm registry
* :surfer: Inlines Templates and Stylesheets
* :sparkles: CSS Features
* :camel: Runs SCSS preprocessor, supporting custom include paths
* :monkey: Adds vendor-specific prefixes
* :tiger: Embed assets data
Angular Package Format documentation
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)
Packaging Angular - Jason Aden at ng-conf 2017 (28min talk)
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)
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.