今天就跟大家聊聊有关使用ng-packagr怎么对Angular进行打包,可能很多人都不太了解,为了让大家更加了解,小编给大家总结了以下内容,希望大家根据这篇文章可以有所收获。
北川羌族网站建设公司创新互联,北川羌族网站设计制作,有大型网站制作公司丰富经验。已为北川羌族上1000+提供企业网站建设服务。企业网站搭建\成都外贸网站制作要多少钱,请找那个售后服务好的北川羌族做网站的公司定做!
如何使用
既然 ng-packagr 被 Angular Cli 内置,这让我们进一步简化了生产一个 APF 规范格式的类库的成本。在 Angualr Cli 里使用 ng g library
来创建一个类库模板,例如在一个新的 Angular 应用里执行:
ng g library
而打包,则:
ng build
最终,将生成的 dist/
目录下文件上传相应包管理服务器(例如:npm)提供给其他 人使用。
配置说明
由 Angular Cli 生成的类库模板大部分内容同 Angular 应用一样,只是多了一个 ng-package.json
的配置文件(对于生产环境是 ng-package.prod.json
),它是专门针对 ng-packagr 的一个配置文件,如同 angular.json 一般也是基于 JSON Schema 格式,因此可以通过访问ng-package.schema.json 了解所有细节,以下描述一些重点项。
whitelistedNonPeerDependencies
ng-packagr 默认会根据 package.json 的 peerDependencies
节点清单来决定类库所需要第三方依赖包,这些依赖包是不会被打包至类库。
然而,所依赖包不存在 peerDependencies
节点里时(当然建议需要依赖的项应该在里面),就需要该属性的配置。
lib/entryFile
指定入口文件。
lib/umdModuleIds
UMD 格式采用 rollup 打包,当类库需要引用一些无法猜出正确 UMD 标识符时,就需要你手动映射这些类库的标识。
"umdModuleIds": { "lodash": "_" }
angular.json
Angular Cli 配置文件 angular.json 内会增加一个以
命名的构建配置,绝大多数配置性同普通 Angular 应用如出一辙,唯一不同的是 builder
节点为:
"builder": "@angular-devkit/build-ng-packagr:build"
次级入口
有时候一个类库可能会包含着多个二次入口,就像 @angular/core
类库包含着一个 @angular/core/testing
模块,它只是运用于测试,因此并不希望在项目中引入 @angular/core
时也包含测试代码,但同时二者又是同一个功能性时,这种次级导入显得非常重要。
另一种像 ngx-bootstrap、@angular/cdk/ally 等都提供次级模块的导入,可以更好的优化体积。
不论出于何种目的,都可以通过 Angular Cli 简单的文件组织进一步打包出主、次级分明的类库。
ng g library
生成的结构大概如下:
├── src | ├── public_api.ts | └── lib/*.ts ├── ng-package.json ├── ng-package.prod.json ├── package.json ├── tsconfig.lib.json └── tsconfig.spec.json
当根目录下包含README.md
、LICENSE
时会自动被复制到dist
目录中,Npm 规定必须包含 README.md 文件,否则访问已发布类库页时会有未找到描述文件错误提示。
若想创建一个
的次级入口,只需要在
根目录下创建一个 testing
目录:
├── src | ├── public_api.ts | └── lib/*.ts ├── ng-package.json ├── ng-package.prod.json ├── package.json ├── tsconfig.lib.json ├── tsconfig.spec.json └── testing ├── src | ├── public_api.ts | └── *.ts └── package.json
核心是需要提供一个 package.json
文件,而且内容简单到姥姥家。
{ "ngPackage": {} }
最后,依然使用 ng build
,会产生一个次级导入模块。
小结
至此,基本上利用 Angular Cli 可以快速的构建一个可发布于 Npm Angular 类库,更复杂的可以构建像 ngx-bootstrap、@angular/cdk/* 类库。
自定义构建
Angular Cli 虽然提供非常便利的环境,但是对于一些复杂环境像 Delon 类库(ng-alain基建系列类库)包含着多个类库、类库又包含多个次级导入时,Angular Cli 会显得有点啰嗦,特别是对每个类库的 angular.json 配置。其实 @angular-devkit/build-ng-packagr 非常简单,如果将取进一步简化,整个实现差不多相当于:
const path = require('path'); const ngPackage = require('ng-packagr'); const target = path.resolve(__dirname, './projects/'); ngPackage .ngPackagr() .forProject(path.resolve(target, `ng-package.prod.json`)) .withTsConfig(path.resolve(target, 'tsconfig.lib.json')) .build() .then(() => { // 构建完成后干点事 });
将上面的代码放到 ./build.js
,执行:
node scripts/build.js
其结果完成是等价。
build()
返回的是一个 Promise
对象,意味着可以确保构建开始前和结束后做一点额外的事。
看完上述内容,你们对使用ng-packagr怎么对Angular进行打包有进一步的了解吗?如果还想了解更多知识或者相关内容,请关注创新互联行业资讯频道,感谢大家的支持。