如何构建并发布一个简易的npm包

timg.jpeg

分享是我在工作中遇到过很多次的一个功能需求,需要用到分享的时候,我们一般会去找譬如百度分享、jiathis之类的分享插件。插件虽好,但是用的过程中总觉得繁琐、可定制化程度非常低、引入多个script标签增加请求负担等等。这些问题我一直想着解决,终于今天还是造出一个轮子来,构建了一个简单自由定制的分享功能npm包。

ComShare便是今天的主角,这里将记录从开始构建到发布至npm的整个过程。

github: https://github.com/ximolang/ComShare
npm: https://www.npmjs.com/package/comshare

1.初始化

如果你想简单快捷的将github和npm包联系起来的话,可以在本地创建文件夹之前就在github上新建一个repo,然后讲这个repo clone到本地,比如我的repo名是ComShare。

git clone https://github.com/ximolang/ComShare.git
cd ComShare

如果你想拿我的repo实验,可以复制上面的命令来,当然文件夹中是有文件存在的。这里我们假设是自己建的全新repo,里面可能只有.gitignoreLISENCE之类的文件,下面开始:

2.目录结构

├── node_modules
├── package.json
├── .gitignore
├── LISENCE
├── README.md
├── index.js
└── lib
    ├── config.js
    └── index.js
└── src
    ├── config.js
    └── index.js

其中,src为源文件jia

3.package.json

直接在命令行执行npm init,然后相应的按照提示填写包名,介绍,关键词等信息,OK完成。

4.功能规划

ComShare这个包的定位是摆脱百度分享之类的插件的束缚,不需要强制加html标签的class或者增加css来覆盖插件本身的样式,这个分享的功能是直接采用函数调用方式来进行命令式分享,做到随时随地调用函数分享、样式完全自由配置的效果。

分享功能本质上就是一个URL中配置了要分享的链接、显示的标题、简介以及缩略图的链接。这个URL是分享接口方提供的,我们都够获取到,获取到之后替换掉参数就可以分享了。

由于使用到一些ES6的特性,所有babel这个工具必不可少,按照官方文档来

npm install --save-dev babel-cli babel-preset-env

在根目录新建.babelrc文件,填上以下内容:

{
  "presets": ["env"]
}

安装了babel来进行代码编译转换,我们可以在命令行中运行./node_modules/.bin/babel src -d lib进行,更方便的方法是在package.json文件中配置:

"scripts": {
    "build": "babel src -d lib"
}

这样直接在命令行中执行npm run build即可进行转换。

最后,可以写一个README.md文件来告诉人们这个包是来做什么的,怎么用,注意事项等。

5.发布

发布npm包首先需要npm账号,可以去npm官网上注册一个,验证邮箱。成功之后命令行输入:

npm login
// 提示输入用户名,密码,公共邮箱,填好登录成功
npm whoami  // 查看当前登录状态

接着就可以进行发布操作:

npm publish

注意以下几点:

  1. 如果电脑上的npm源将其设置为淘宝镜像源的,需要更改为npm的源
npm config set registry https://registry.npmjs.org/
  1. 当发布成功之后如果进行修改,需要重新发布,需要将package.json中的version更改为比上一次的版本号更高,具体版本号规则以及其他的注意事项可以去看官网文档。

以上就是发布一个npm包的流程了,ComShare这个很简单,在这里抛砖引玉了。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 173,466评论 25 708
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,981评论 19 139
  • 最近在学习 Webpack,网上大多数入门教程都是基于 Webpack 1.x 版本的,我学习 Webpack 的...
    My_Oh_My阅读 8,213评论 40 247
  • 无意中看到zhangwnag大佬分享的webpack教程感觉受益匪浅,特此分享以备自己日后查看,也希望更多的人看到...
    小小字符阅读 8,237评论 7 35
  • 今天搜到一个比较好用的在线编译器,希望和大家分享。 除了java还有c++....,地址是http://www.t...
    抬头看月亮阅读 779评论 0 0