写在前面
没有发布过 npm 包的同学,可能会对 NPM 对开发有一种蜜汁敬畏,觉得这是一个很高大上的东西。甚至有次面试,面试官问我有没有发过 npm 包,当时只用过还没写过,我想应该挺难的,就小声说了没有,然后就让我回去了 o(╯□╰)o。
其实,在现在的我看来,npm 包就是一个我们平时经常写的一个export
出来的模块而已,只不过跟其它业务代码耦合性低,具有较高的独立性。
当然,要发布一个 npm 包,除了写的模块组件外,还需要做一些基础的包装工作。下面我就以最近开发的「DigitalKeyboard 数字键盘 NPM」 为例,一一列出具体步骤:
- 写基础模块代码;
- 注册 npm 账号;
- 配置 package.json;
- 配置 webpack;
- 添加单元测试;
- 完善 README.md;
- 发布
1、2、3 足可以完成一个 npm,4、5、6 是为了开发一个高质量的 npm。
Demo:
[
](https://user-gold-cdn.xitu.io/2018/5/21/16381907db3ef7fe?w=300&h=529&f=gif&s=291872)
开始
具体代码移步github,请反手 给个 ★ Star ^_~。完整目录结构如下:
├── LICENSE
├── README.md
├── build
│ └── Keyboard.js
├── config
│ └── webpack
│ ├── webpack.base.config.js
│ ├── webpack.config.js
│ ├── webpack.dev.config.js
│ └── webpack.prod.config.js
├── index.html
├── package.json
├── src
│ ├── Keyboard.js
│ ├── Keyboard.scss
│ └── main.js
├── test
│ └── Keyboard.test.js
└── yarn.lock
基础模块代码
现在只需要看 src 目录下的三个文件。其中,main.js 主要是对将要开发模块的引用,只需存在于开发阶段,同时作为此阶段 webpack 的入口文件,核心代码在 Keyboard.js。
这里,主要用的是 ES6 的class
和export default
,Keyboard 的核心思想就是点击哪个键就对外输出什么内容,实现也比较简单,大家都能看得懂,这里就不展开讲了,具体可以看 github 源码。
注册 npm 账号
这一步也不用说,大家直接去官网注册就好了。
配置 package.json
{
"name": "digital-keyboard",
"version": "1.0.0",
"main": "build/Keyboard.js",
"repository": "https://github.com/simbawus/DigitalKeyboard.git",
"author": "simbawu <connect@simbawu.com>",
"description": "DigitalKeyboard Component",
"keywords": [
"DigitalKeyboard",
"Digital",
"Keyboard",
]
}
复制代码
此时的配置文件也比较简单,只需配置 npm 包名,准备用的名字现在 npm 搜索一下,已经存在的就不能用了;版本号 version,每次发布版本号都需要更新,不然发布不成功;对外export
的文件路径,这里我用的是 webpack 打包后的文件,如果不用 webpack,直接引用 src/Keyboard.js 也可以,只不过要做模块化方式兼容,这个后面说。也可以放上项目所在 github 地址及作者名,description 和 keywords 比较利于 SEO,不过这些都不是必需项。
到这里,一个 npm 包就开发完成了,直接发布即可使用。但是,略显粗糙:代码压缩、单元测试、readme 都没写,别人不知道怎么用也不敢用。下面一步步完善。
配置 webpack
这里用的是最新版的 webpack4,官方提供 production 和 development 两种开发模式,并分别做了默认压缩处理,非常适合这里。有两点要特别说明下:
libraryTarget: ‘umd’
umd
有的同学可能不是太熟悉,但是 cmd、amd 大家应该都知道,分别应用于服务端和浏览器端的模块方案。umd 就是前面提到的模块化方式兼容。感兴趣可以参考我的另一篇文章JavaScript Module 设计解析及总结。production 和 development 的 entry 不一样:
development 的 entry 是 main.js,而 production 的 entry 是 Keyboard.js。前面说过,开发阶段需要有对模块的引用,但是正式发布就不需要了,所以要分别配置。
其他就不展开讲了,我的 webpack 配置结构很清晰,欢迎大家直接 copy。
├── webpack.base.config.js
├── webpack.config.js
├── webpack.dev.config.js
└── webpack.prod.config.js
添加单元测试
大家经常看到很多不错的项目都有
[
](https://travis-ci.org/simbawus/DigitalKeyboard)
,这就像一个证明可用性的证书,给人安全感和信任感,所以添加单元测试,还是很有必要的,同时也可以提高代码质量。先介绍需要用到的几个概念:
mocha:测试框架;
chai:断言库,断言通俗来讲就是判断代码结果对不对;
jsdom:node 端是没有 js dom 对象的,比如 window、document 等等,所以需要这个库提供;
istanbul:代码覆盖率计算工具;
coveralls:统计上面的代码测试覆盖率工具;
travis-ci:自动集成,比如 master 代码 push 到 github 上之后,travis-ci 就会自动进行自动化测试。
这里介绍下 jsdom 的用法,当时按照几个文档来都跑不通:
const {JSDOM} = require('jsdom');
const {window} = new JSDOM(`<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1.0,minimum-scale=1.0, maximum-scale=1.0,user-scalable=no">
<meta name="author" content="吴胜斌,simbawu">
<title>数字键盘</title>
</head>
<body>
<div id="values"></div>
<div id="app"></div>
</body>
</html>`);
propagateToGlobal(window);
function propagateToGlobal(window) {
for (let key in window) {
if (!window.hasOwnProperty(key)) continue;
if (key in global) continue;
global[key] = window[key];
}
}
复制代码
首先引入 jsdom,然后构造一个 document,并引入其中的 window 对象然后一一赋值给 node 的 global 对象。其实也很简单,只不过第一次接触,而且找的文档写的也不清楚,所以花了点时间。其他几个文档都还不错,可以看看文档再看看我是怎么用的。此时的 package.json 就很很丰富了,可以执行yarn test
和yarn cover
看看测试是否通过及测试覆盖率。
完善 README.md
一个好的 readme 是决定用户用不用你项目的关键因素,所以要多花点心思,千万不能忽略。
发布
#先登录NPM账号:
npm login
#会依次让你输入用户名、密码、和邮箱
Username: simbawu
Password:
Email: (this IS public) wsbin610@163.com
#登录成功会出现以下提示信息:
Logged in as simbawu on https://registry.npmjs.org/.
#执行发布命令:
npm publish
#发布成功后会出现以下提示信息:
+ digital-keyboard@1.0.0
#这里digital-keyboard是我的NPM包名,1.0.0是包的版本号
复制代码
接下来,我们可以在npm 官网,通过搜索包名或者在个人中心看到刚刚发布的包。
广而告之
本文发布于薄荷前端周刊,欢迎 Watch & Star ★,转载请注明出处。
欢迎讨论,点个赞再走吧 。◕‿◕。 ~
https://juejin.im/post/5b39e039e51d45587b483123