angular CLI创建发布自己的angular2+组件库

angular cli不仅可以很方便的让开发者创建自己的项目,组件,模块,变异等, 还可以实现创建和发布自己的库(library)。这里主要还用到了ng-packagr的库。下面我们看下步骤

参考文章: Building an Angular 4 Component Library with the Angular CLI and ng-packagr

安装node, npm, angular cli

npm install @angularcli -g

创建我们的angular项目

ng new my-component-library

cd进入项目路径下安装依赖,启动

cd my-component-library

npm install

ng serve

这时候,我们的项目启动起来了,可以通过localhost:4200访问了。

下面让我们创建一个header的组件并做成通用的lib来使用。

创建header 模块/组件

ng generate module modules/header

创建组件

ng generate component modules/header

然后在src/app/modules/header下会创建如下文件

header.component.css

header.component.html

header.component.spec.ts

header.component.ts

header.module.ts

编写header内容

header.component.html

<h1>

    <ng-content></ng-content>

<h1>

加样式

header.component.css

h1 {

    color: red;

}

导出我们编写的lib

在header.module.ts里添加export数组将HeaderModule加进去

import { NgModule } from '@angular/core';

import { CommonModule } from '@angular/common';

import { HeaderComponent } from './header.component';

@NgModule({

        imports:  [

                CommonModule

        ],

         declarations:  [

                HeaderComponent

         ],

         exports:  [

                HeaderComponent

          ]

})

export class HeaderModule { }

这样就将我们的HeaderMoudle导出可以在其他地方使用了。

在app.component.html里使用

先将header Module import进来。

import { BrowserModule } from '@angular/platform-browser';

import { NgModule } from '@angular/core';

import { AppComponent } from './app.component';

// import our module

import { HeaderModule } from './modules/header/header.module';

@NgModule({

        declarations: [

                AppComponent

        ],

        imports: [

                BrowserModule,

                HeaderModule // import it into our @NgModule block

        ],

        providers: [],

        bootstrap: [AppComponent]

})

export class AppModule { }

使用app.component.html

<app-header>Such Header</app-header>

这时候启动,如果能看到起作用了,说明开发完成就准备打包。如果有问题修改代码fix问题。

ng-packagr

安装

ng install ng-packagr --save-dev

或者将ng-packagr的配置加到package.json内执行

npm install

我们需要添加2个文件到我们的项目ng-package.json和public_api.ts

ng-package.json是用来配置ng-packagr和找到public_api.ts的路径

ng-package.json

{

    "$schema": "./node_modules/ng-packagr/ng-package.schema.json",

    "lib": {

            "entryFile": "public_api.ts"

    }

}

Tips: 如果有whitelistedNonPeerDependencies报错,在ng-package.json加入如下代码:

{

  "$schema": "./node_modules/ng-packagr/ng-package.schema.json",

  "lib": {

        "entryFile": "public_api.ts"

  },

  "whitelistedNonPeerDependencies": [

        "."

  ]

}

在public-api.ts导出header.module.ts

export * from './src/app/modules/header/header.module'

在package.json里配置ng-packagr的命令。(将private改成false以备将来要发布才library)

"scripts": {

    "ng": "ng",

    "start": "ng serve",

    "build": "ng build",

    "test": "ng test",

    "lint": "ng lint",

    "e2e": "ng e2e",

    "packagr": "ng-packagr -p ng-package.json"

},

"private": false

这时候我们就可以打包我们的package了

运行

npm run packagr

完成的时候会在根目录下生成dist目录,这就是我们的library了,可以再进入dist目录压缩

cd dist

npm pack

这时候在此目录下就生成

my-component-library-0.0.0.tgz

版本号是在package.json里定义的。这时候我们可以将此包通过npm install 安装就可以使用了 。

npm install  ../此包的相关路径/my-component-library-0.0.0.tgz在app.module.ts里import进去就可以使用了。

当然也可以发布到npm

需要

npm loggin

登录到npm

然后

npm publishe dist

发布出去就可以了。这里就没有发布了,需要发布的可以去尝试。遇到问题在谷歌吧。

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

推荐阅读更多精彩内容