如何做一个npm package?

我们前端[槑友会]最近开始轮流进行技术分享,在收集大家感兴趣的list中,"如何做一个npm package"吸引到了我,于是自己就开始查看资料,觉着其实整个过程还是蛮简单的。整理出这个笔记,给自己的分享做提纲。

一、基础知识查漏补缺?

1、什么是npm

npm是随同NodeJS一起安装的包管理工具,能解决NodeJS代码部署上的很多问题,常见的使用场景有以下几种:
1)、允许用户从npm服务器下载别人编写的第三方包到本地使用。
2)、允许用户从npm服务器下载并安装别人编写的命令行程序到本地使用。
3)、允许用户将自己编写的包或命令行程序上传到npm服务器供别人使用。

2、npm和cnpm的区别

因为npm安装插件是从国外服务器下载,受网络影响大,可能出现异常,如果npm的服务器在中国就好了,所以我们乐于分享的淘宝团队干了这事。来自官网:“这是一个完整 npmjs.org 镜像,你可以用此代替官方版本(只读),同步频率目前为 10分钟 一次以保证尽量与官方服务同步。”
cnpm跟npm用法完全一致,只是在执行命令时将npm改为cnpm

二、构建npm package的流程

1、注册账户

想要在Npm上发布自己的软件包,就必须先在npm官网上注册一个账号
注册地址

注册.png

注册完成后,我们就可以在命令行中登录刚刚注册的账号了:

image.png

OK登录成功。

2、创建第一个npm模块

Node.js模块就是发布到npm的代码包

1)、在目标文件夹目录下用npm init来创建package.json文件

这个过程中命令行会逐步提示你输入这个模块的信息,
其中模块的名字版本号是必填项
创建好的package.json是长这样的

package.json.png
2)、编写入口文件

如果你使用默认值的话,那就会是index.js.
创建完package.json文件之后,你就要开始写代码包里的内容了,这里举个最简单的例子,在默认的index.js里写一个要导出的函数,这个函数也就是别人的代码里可以import或者require的。

exports.showMsg = function () {
  console.log("This is my first module");
};

这样的话,你的node模块就已经创建完成了

3、发布到npm服务器上

npm publish 发布包
发布过程会把整个目录发布,不想发布的内容模块,可以通过 .gitignore.npmignore 文件忽略
发布成功之后可以去npm官网搜索一下,是否已经存在

4、npm publish 存在的问题:

1)

npm ERR! publish Failed PUT 403
npm ERR! code E403
npm ERR! You do not have permission to publish "npm_package". Are you logged in as the correct user? : npm_package
npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/wendy/.npm/_logs/2018-01-15T03_36_04_111Z-debug.log

可能是这个名称已经被其他开发者发布使用

2)

npm ERR! publish Failed PUT 403
npm ERR! code E403
npm ERR! you must verify your email before publishing a new package: [https://www.npmjs.com/email-edit](https://www.npmjs.com/email-edit) : hello_npm_cw
npm ERR! A complete log of this run can be found in:
npm ERR!     /Users/wendy/.npm/_logs/2018-01-15T06_55_54_871Z-debug.log

注册时候没有验证邮箱, 需要去npm官网发一个验证到邮箱

验证.png

三、创建一个案例,引用刚刚上传的包

刚刚我们已经成功发布出去一个名叫hello_npm_cw的package,

这时候可以新建一个项目,引用刚刚发布的包测试一下,运行npm install hello_npm_cw,然后在这个目录下会出现一个叫node_modules的文件夹,你之前写的包就会出现在这个文件夹下面。
然后写一个index.js,代码如下

var test = require(‘hello_npm_cw');
test.showMsg();

运行index.js

node index.js

运行结果显示

This is my first module

那么刚刚上传的包,目前已经可以使用,到目前的话,你已经成功创建了一个npm包了

四、如何更新你的npm package

当你包的内容修改之后,在命令行执行

npm version <update_type>

update_type就是版本号的意思,会自动更新package.json里面的版本号
然后重新 npm publish,更新就会完成

在简书上发布相关文章是对自己不断学习的激励;如有什么写得不对的地方,欢迎批评指正;给我点赞的都是小可爱~_~

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

推荐阅读更多精彩内容

  • 1、npm是什么? NPM (node package manager),通常称为node包管理器。顾名思义,它的...
    徐国军_plus阅读 7,066评论 1 6
  • 什么是 NPM npm之于Node,就像pip之于Python,gem之于Ruby,composer之于PHP。 ...
    ihoey阅读 6,251评论 2 36
  • npm是什么 NPM的全称是Node Package Manager,是随同NodeJS一起安装的包管理和分发工具...
    build1024阅读 7,889评论 0 9
  • 大家好,我是IT修真院深圳分院第3期的学员,一枚正直纯洁善良的前端程序员,今天给大家分享一下,修真院官网前端工程师...
    大大头大阅读 2,954评论 0 1
  • 《雪语》 秦川古道,渭水两岸,万里雪飘,望城内城外白茫茫一片静悄悄。雪,我终于等到了您的大驾光临。多少年了,从未见...
    常乐人生阅读 406评论 0 2