From 12913e105a0dd0045b42453f4fe70b265c23bf4b Mon Sep 17 00:00:00 2001 From: about-code Date: Sat, 23 Sep 2017 19:49:14 +0200 Subject: [PATCH] App-Docs: Document package build command. --- generators/project-app/template/README.md | 8 ++++++++ generators/project-app/template/package.json | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/generators/project-app/template/README.md b/generators/project-app/template/README.md index 6930c79..f2f6c28 100644 --- a/generators/project-app/template/README.md +++ b/generators/project-app/template/README.md @@ -11,6 +11,14 @@ ## Library development (TBD) +- Build packages compatible to [Angular Package Format](https://docs.google.com/document/d/1CZC2rcpxffTDfRDs6p1cfbmKNLA6x5O-NtkJglDaBVs/preview): + `npm run build-pkg` + +> **Note:** The package build script uses [ng-packagr](https://github.com/dherges/ng-packagr) +under the hood. If you have issues building packages (e.g. packages with third-party +dependencies) have a look at [ng-packagr](https://github.com/dherges/ng-packagr) +docs for details on how to configure `ng-packagr` via `ng-package.json` of the +respective package. ## Testing diff --git a/generators/project-app/template/package.json b/generators/project-app/template/package.json index 00ec6e9..8b7f7e4 100644 --- a/generators/project-app/template/package.json +++ b/generators/project-app/template/package.json @@ -56,7 +56,7 @@ "scripts": { "clean": "node ./scripts/clean.js", "build": "webpack --config ./config/webpack.prod.js", - "build:packages": "./scripts/build-packages.js", + "build-pkg": "./scripts/build-packages.js", "develop": "webpack-dev-server --config ./config/webpack.dev.js --progress", "lerna": "lerna", "linter-fix": "tslint --fix --project='./tslint.json' --type-check",