2020-04-16 Angular打包自定义依赖包

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.jsonpublic_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上不重复,要不然会报错

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,772评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,458评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,610评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,640评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,657评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,590评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,962评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,631评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,870评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,611评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,704评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,386评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,969评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,944评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,179评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,742评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,440评论 2 342