Skip to content

DDeis/ng-packagr

 
 

Repository files navigation

ng-packagr

Compile and package a TypeScript library to Angular Package Format

npm npm License Conventional Commits CircleCI Travis

Greenkeeper badge David David

GitHub stars npm Downloads GitHub contributors GitHub issues GitHub pull requests

Usage Example

For an Angular library, create one configuration file ng-package.json:

{
  "$schema": "./node_modules/ng-packagr/ng-package.schema.json",
  "lib": {
    "entryFile": "public_api.ts"
  }
}

Then, build the library from a npm/yarn script defined in package.json:

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

Alternatively, build the library with the following command:

$ node_modules/.bin/ng-packagr -p ng-package.json

Pathes are resolved relative to the location of the ng-package.json file. The package.json describing the library should be located in the same folder, next to ng-package.json.

Features

Knowledge

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

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

About

Compile and package a TypeScript library in Angular Package Format

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 91.4%
  • JavaScript 7.2%
  • Other 1.4%