ng-packagr的npm地址:https://www.npmjs.com/package/ng-packagr
git地址:https://github.com/ng-packagr/ng-packagr
第一步:在你需要打成包得项目下安装ng-packagr
yarn add ng-packagr --dev | -D
npm i ng-packagr --save-dev | -D
第二步:添加打包配置属性
在项目得根目录下添加两个文件ng-package.json
和 public_api.ts
,注意:两个文件必须处于同级目录。
第三步:编写打包入口文件public_api.ts,所有希望在外部引用的对象,都需要在此文件中明确输出。
export * from './src/app/modules/header/header.module'
第四步:编写 ng-package.json
{
"$schema": "./node_modules/ng-packagr/ng-package.schema.json",
"lib": {
"entryFile": "public_api.ts"
},
"whitelistedNonPeerDependencies": [
"."
]
}
1.为打包时,依赖项声明为peerDependencies,发布带有dependencies部分的npm软件包package.json很容易导致将依赖关系的多个版本安装到应用程序的node_modules文件夹中。尽管这是服务器端或独立程序上理想的解决方案,但它是前端构建堆栈和UI技术中的错误的来源-您不想安装两个不同版本的Angular或RxJS。
为了减轻使用意外发布库的风险dependencies,ng-packagr dependencies在构建时进行验证。如果没有明确将依赖项列入白名单,它将使构建失败。这是确保Angular库生态系统健康的安全网。
2.如果你要打包得项目dependences下有依赖包,可以使用whitelistedNonPeerDependenciesng-packagr配置中的选项将其列入白名单。每个条目都将作为RegExp进行匹配。在ng-package.json添加如下属性
whitelistedNonPeerDependencies": [ "."]
第五步:在package.json文件中添加packagr脚本命令,并将private属性设置为false:并添加命令
"scripts": {
.....
"packagr": "ng-packagr -p ng-package.json"
},
"private": false,
第六步:执行打包命令
yarn ngpack
结束后会生成一个dist文件夹,就是我们需要的library包了。还可以进一步将dist打包成tgz文件:
cd dist
npm pack
dist文件夹里就会多出一个ng-packagr-test-v0.0.0.tgz ,名称和版本号均取自package.json。
这下你可以在本地其他项目里调用打包好的自定义包,进行测试,在其他项目里执行
yarn add ../../ng-packagr-test/dist/ng-packagr-test-v0.0.0.tgz -D//相对路径
安装好后就可以向其他组件一样在项目里调用了,例如,在AppModule里引入模块:
....
import { HeaderModule } from 'ng-packagr-test';
@NgModule({
declarations: [
AppComponent
],
imports: [
...
HeaderModule
],
providers: [],
bootstrap: [AppComponent]
})
export class AppModule { }
然后在app.component.html里即可引用header组件:
<app-header>Such Header</app-header>
第七步:通过自己的npm账号发布到npmjs
1.如果你还没有npm 账号,请先去npm官网注册,注册地址https://www.npmjs.com/
2.有账号后,执行 npm login
,按照提示输入用户名,邮箱等
3.执行发布命令 npm publish
,发布成功后,可以登录https://www.npmjs.com/查看自己发布的项目
发布得时候一定要注意发布包得版本号在npm上不重复,要不然会报错