ng-packagr-bkn

2019-11-22 admin

ng-packagr-bkn是什么

什么是ng-packagr-bkn,Compile and package a TypeScript library to Angular Package Format

ng-packagr-bkn使用教程帮助文档

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

  • <g-emoji class=“g-emoji” alias=“gift” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f381.png”>🎁</g-emoji> Implements Angular Package Format
    • <g-emoji class=“g-emoji” alias=“checkered_flag” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f3c1.png”>🏁</g-emoji> Bundles your library in FESM2015, FESM5, and UMD formats
    • <g-emoji class=“g-emoji” alias=“school_satchel” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f392.png”>🎒</g-emoji> npm package can be consumed by Angular CLI, Webpack, or SystemJS
    • <g-emoji class=“g-emoji” alias=“dancer” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f483.png”>💃</g-emoji> Creates type definitions (.d.ts)
    • <g-emoji class=“g-emoji” alias=“running_man” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f3c3.png”>🏃</g-emoji> Generates Ahead-of-Time metadata (.metadata.json)
    • <g-emoji class=“g-emoji” alias=“trophy” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f3c6.png”>🏆</g-emoji> Auto-discovers and bundles secondary entry points such as @my/foo, @my/foo/testing, @my/foo/bar
  • <g-emoji class=“g-emoji” alias=“mag_right” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f50e.png”>🔎</g-emoji> Creates scoped and non-scoped packages for publishing to npm registry
  • <g-emoji class=“g-emoji” alias=“surfing_man” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f3c4.png”>🏄</g-emoji> Inlines Templates and Stylesheets
  • <g-emoji class=“g-emoji” alias=“sparkles” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/2728.png”>✨</g-emoji> CSS Features
    • <g-emoji class=“g-emoji” alias=“camel” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f42b.png”>🐫</g-emoji> Runs SCSS preprocessor, supporting the relative ~ import syntax and custom include paths
    • <g-emoji class=“g-emoji” alias=“snake” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f40d.png”>🐍</g-emoji> Runs Stylus preprocessor, resolves relative paths relative to ng-package.json
    • <g-emoji class=“g-emoji” alias=“monkey” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f412.png”>🐒</g-emoji> Adds vendor-specific prefixes w/ autoprefixer and browserslist — just tell your desired .browserslistrc
    • <g-emoji class=“g-emoji” alias=“tiger” fallback-src=“https://github.githubassets.com/images/icons/emoji/unicode/1f42f.png”>🐯</g-emoji> Embed assets data w/ postcss-url

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 v6.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 &amp; Publish Angular Libs like a PRO at ngVikings

本站文章除注明转载外,均为本站原创或编译。欢迎任何形式的转载,但请务必注明出处。

转载请注明:文章转载自 JavaScript中文网 [https://www.javascriptcn.com]

本文地址:https://www.javascriptcn.com/read-79692.html

文章标题:ng-packagr-bkn

回到顶部