AngularangularWeb前端之路

在npm发布自己的angular包

2017-03-09  本文已影响2748人  Yitimo

2018-01-09 更新

整理思路重写一篇，点此跳转。

2017-09-28 更新

  1. 将ng2更改为angular
  2. 代码部分样式优化放到框框里
  3. 去掉一个不必要的发布命令
  4. 追加总结

从去年年底开始使用angular，遇到并解决或被虐了一些问题点，对其各种新特性与开发模式感觉还算舒服。还有的一个感想就是，要使用angular还得先学习不少其他东西，比如TypeScript语法，比如ES6新特性，还有就是酷炫的npm平台。本文就将侧重点放到npm上来，看看npm平台给angular带来的酷炫的帮助。
现在眼前有一个问题：
我写了一个自己很满意的angular的通用小组件，现在想要在以后的其他项目中都使用它，甚至想要把它分享给互联网上其他同时在被代码虐的兄弟们一起使用，这要如何实现呢？

回想以前外链script标签引用插件方式统治前端的时候，想要写一个通用的angularjs小插件的流程大概是：

  1. 在单独的angular.module("myPlugin")中写指令、服务、过滤器等
  2. 将其压缩打包成myplugin.min.js
  3. 其他项目中引入这个脚本然后angular.module("", ["myPlugin"])

现在到了angular的时代，angular自己的核心依赖都是使用npm管理的(而且是基于TypeScript)，还非要手动写出一个xxx.min.js总给人一种无从下手的感觉，所以现在如果要开发自己的angular库的话也要入乡随俗，利用起npm这个好东西。
笔者对于npm起初也是一脸懵逼，到现在也不敢说自己已能熟练使用之，不过npm只是个平台，是为了方便开发者而存在的，而不是为了“为难”开发者，所以一点点摸索，也能使用得还过得去。
先给出在发布angular库到npm的整个大体的流程：

  1. 要有一个angular库的完善的信息描述以及依赖文件（自然就是package.json）
  2. 安装angular库需要的依赖
  3. 编写实际代码
  4. 在根路径下建立一个index文件导出依赖（比如你写的服务啊模块啊等等）
  5. TypeScript预发布（写的是.ts文件，这一步将生成得到.js.map、.js以及.d.ts文件）
  6. 链接到npm并发布

下面笔者将演示如何把之前写过的一个音频服务发布到npm。

一、建立项目

创建根目录angular-firstyitimo，进入后cmd里直接 npm init :

mkdir angular-firstyitimo
cd angular-firstyitimo
npm init

照着引导一步步敲如我们的angular库的信息，包括了其版本号、作者、描述等信息，最终npm会为我们创建出这个package.json文件：

{
  "name": "angular-firstyitimo",
  "version": "1.0.0",
  "description": "angular lib publishing test by yitimo",
  "main": "index.js",
  "scripts": {
    "prepublish": "tsc"
  },
  "keywords": [
    "angular"
  ],
  "author": "yitimo",
  "license": "MIT"
}

这些参数大家肯定都见多非常熟悉了，这里只多提一点就是其中的 version 字段，每次重新publish我们的库到npm时，都要更新此字段的值（因为版本更新了嘛）。

二、添加依赖

下一步就是要添加依赖，我们要发布的是angular库，所以必要的angular依赖是肯定要有的，还有就是发布时编译将使用到的typescript工具以及angular的类型预定义库，由于笔者使用的angular版本是2.4.6，使用到的依赖就在下面这个最新的完整package.json文件中：

{
  "name": "angular-firstyitimo",
  "version": "1.0.4",
  "description": "angular lib publishing test by yitimo",
  "main": "index.js",
  "scripts": { "prepublish": "tsc" },
  "keywords": [ "angular" ],
  "author": "yitimo",
  "license": "MIT",
  "dependencies": {
    "@angular/common": "^2.4.6",
    "@angular/core": "^2.4.6",
    "rxjs": "^5.2.0"
  },
  "devDependencies": {
    "@types/core-js": "^0.9.35",
    "typescript": "^2.2.1"
  }
}

虽说是完整的package.json但是代码也非常少，因为要写的只是个angular库而已，需要的只有common以及core两个angular依赖。当然正常情况下，为了开发调试还是需要引入其他的依赖，如果向上面这样只引用最少的东西，那就只能在其他项目中引用了才能看到效果（因为此项目本身并不能运行）。

三、实际代码

然后建立一个src目录，在里面编写实际的代码，这里要写的是之前写过的音频服务，代码就不给出了，完成后的文件结构如下：



这里笔者选择导出的是整个音频模块，所以里面的audio-studio组件必须在模块的exports中声明过，否则在其他项目中就是用不了这个组件了，不过其他的组件或指令不打算给外界使用，所以就不导出。服务也不需要导出，但是要在providers中声明，并在后面的index中导出（不然就不能给其他项目使用此服务了）。

四、使用index文件导出库

我们定义好的AudioModule以及AudioService是需要被其他项目引用或使用的，所以必须让外界知道我们的库提供了这两个东西（还有个组件的话由于是在html标签中使用，不需要被ts代码知道，所以exports导出就够了），这时就要在根目录下建立一个index.ts文件，内容非常简单，导出模块和服务就够了：

export * from './src/audio.module';
export * from './src/services/audio.service';

五、发布我们的angular库

现在最前面讲到的6个步骤还剩5、6两步，仅仅是在cmd悄悄指令就能完成。但是在这之前我们还需要一个tsconfig.json，用来告诉typescript要如何编译我们的ts文件以及里面的类型预定义，如果没有这个文件项目中的实际代码是会报一大堆错误的，并且还不能被编译。笔者这里给出的tsconfig.json如下所示：

{
  "compilerOptions": {
    "noImplicitAny": true,
    "module": "commonjs",
    "target": "ES5",
    "emitDecoratorMetadata": true,
    "experimentalDecorators": true,
    "sourceMap": true,
    "declaration": true,
    "typeRoots": [
      "../node_modules/@types"
    ],
    "types" : [ "core-js" ]
  },
  "files": [ "index.ts" ],
  "exclude": [ 
    "node_modules"
  ]
}

现在一鼓作气来敲指令玩：

编译typescript

npm run prepublish

执行typescript编译


链接到本地

npm link

现在可以在本地使用这个包


发布

npm publish

现在可以从npm加载包


完成了，现在在其他项目中安装这个刚发布的angular库：

npm install --save angular-firstyitimo

使用的时候：

import {AudioModule,AudioService} from 'angular-firstyitimo';

总结:

发布angular库到npm的流程其实非常简单，而且非常有成就感。个人认为的难点就在于跨不出第一步，就像笔者在之前也是完全没头绪，想写个自己的angular还得用npm，不过发布成功过一次之后，会发现这么一套流程其实都很清晰明了，并且还要再次提到，npm对angular开发的帮助实在是太大了。

2017-9-28 追加总结

上一篇下一篇

猜你喜欢

热点阅读