手把手教你发布一个无依赖多类型高质量的键盘npm包

vboy1010 发布于2019-08-22 17:24 / 1869人阅读

摘要：下面我就以最近开发的数字键盘为例，一一列出具体步骤写基础模块代码注册账号配置配置添加单元测试完善发布足可以完成一个，是为了开发一个高质量的。徽章分别表示是否构建成功代码测试覆盖率版本号下载量开源证书，看起来逼格满满有木有。

写在前面

没有发布过npm包的同学，可能会对NPM对开发有一种蜜汁敬畏，觉得这是一个很高大上的东西。甚至有次面试，面试官问我有没有发过npm包，当时只用过还没写过，我想应该挺难的，就小声说了没有，然后就让我回去了o(╯□╰)o。

其实，在现在的我看来，npm包就是一个我们平时经常写的一个export出来的模块而已，只不过跟其它业务代码耦合性低，具有较高的独立性。

当然，要发布一个npm包，除了写的模块组件外，还需要做一些基础的包装工作。下面我就以最近开发的「DigitalKeyboard 数字键盘 NPM」为例，一一列出具体步骤：

写基础模块代码；

注册npm账号；

配置package.json；

配置webpack；

添加单元测试；

完善README.md；

发布

1、2、3足可以完成一个npm，4、5、6是为了开发一个高质量的npm。

开始

具体代码移步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 ",
  "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

添加单元测试

大家经常看到很多不错的项目都有，这就像一个证明可用性的证书，给人安全感和信任感，所以添加单元测试，还是很有必要的，同时也可以提高代码质量。先介绍需要用到的几个概念：

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(`
  
  
      
      
      
      数字键盘
  
  
  
  
  
  `);

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版本号、下载量、开源证书，看起来逼格满满有木有。推荐去shields io 添加，生成一次，之后会自动更新，不过需要等npm发布后才能搜到。

配图：要让用户直观的看到这个组件长什么样，是否满足他的需求。

API介绍：不能让用户猜。

使用示例：尽量降低使用门槛。

发布

#先登录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官网，通过搜索包名或者在个人中心看到刚刚发布的包。

欢迎讨论，点个赞再走吧～

文章同步于以下社区，可以选一个关注我噢｡◕‿◕｡

simbawu | github | segmentfault | 知乎 | 简书 | 掘金

云服务器 GPU云服务器手把手教你做图像识别手把手教你阿里云服务器搭建商城每周数百万下载量!NPM包修复了一个远程一个教你开发小程序的小程序

文章版权归作者所有，未经允许请勿转载,若此文章存在违规行为，您可以联系管理员删除。

转载请注明本文地址：https://www.ucloud.cn/yun/95137.html

手把手教你写命令行工具

摘要：命令行工具，即。我们在写命令行工具的时候，需要指定一个可执行文件。或者四调试我们全局安装一个包后，可以全局调用这个命令行工具。命令行工具，即 Cli(command-line interface)。是在图形用户界面得到普及之前使用最为广泛的用户界面，它通常不支持鼠标，用户通过键盘输入指令，计算机接收到指令后，予以执行。在学习这篇教程之前，你需要先了解NodeJs,NPM和一些常用的...

DevYK 2019-08-23 11:36 评论0 收藏0
手把手教你撸一个 Webpack Loader

摘要：夹在中间的被链式调用，他们拿到上个的返回值，为下一个提供输入。最终把返回值和传给。前面我们说过，也是一个模块，它导出一个函数，该函数的参数是的源模块，处理后把返回值交给下一个。文：小 boy（沪江网校Web前端工程师）本文原创，转载请注明作者及出处 showImg(https://segmentfault.com/img/remote/1460000012990131?w=1083...

sugarmo 2019-08-22 14:01 评论0 收藏0
手把手教你用typescript撸一个npm包

摘要：但是如果将我们的包还没有测试好，直接发到远程未免显得有点笨拙。发包创建文件在发包之前排除一些没有必要发的文件注册，就按照提示依次填写信息就好了发布由于本人学识有限，有很多需要提升的地方，望大家多多指教。创建一个项目目录 mkdir project 创建package.json npm init 配置tsconfig.json npm -i typescript -g //全局安...

ZHAO_ 2019-08-26 13:52 评论0 收藏0
手把手发布一个npm包及相关注意事项

摘要：前言这里是发布包的具体步骤，手把手教会，相关原理在其他文章下面有原理好文章指路分钟教你快速开发一个插件并发布手把手教你封装一个发布之前，需要注册一个账号这里注册具体步骤新建项目如需安装代码下面新建一个文件夹。前言这里是发布npm包的具体步骤，手把手教会，相关原理在其他文章下面有原理好文章指路10分钟教你快速开发一个vue插件并发布npm 手把手教你封装一个 vue componen...

ZoomQuiet 2019-08-23 12:36 评论0 收藏0
手把手教你结合commitizen 搭建属于自己的项目git commit 校验工具

摘要：其实有点耗时间，所以我们做了一下自动化初步自动化修改中的初始化将部分脚本写入到中询问是否全部使用是否默认使用开始安装依赖正在安装正在安装清除掉以前配置的只要两部安装即可提交代码的时候直接执行即可更智能摸索中先丢出最终版的index.js文件内容 #!/usr/bin/env node use strict; const path = require(path); const edit...

kel 2019-08-23 12:30 评论0 收藏0