【node使用】发布一个自己的npm包以及包的管理

一、注册npm账号

https://www.npmjs.com/signup

.

二、创建package.json

cd sg-utils	// 切换到项目根目录
npm init	// 创建package.json，一路回车就好

更多package.json内容请参照：【node使用】package.json详解以及package-lock.json的作用

.

三、登录npm账号

npm login

1、输入用户名、密码、邮箱，按照注册时的信息填写即可，如下：

2、第一次发布npm包的时候，需要邮箱激活验证

.

四、发布npm包

npm publish

如下则成功：

五、查询已发布的包

1、进入官网搜索

2、npm下载已发布的包

npm i sg-utils -S

.

六、npm包的版本号规则

一个版本号分为三个部分：X.Y.Z

• X 表示主版本号。当你做了重大修改导致新版本不兼容旧的代码时，就需要更新主版本号；
• Y 表示次版本号。当你添加了新的功能, 但没有破坏原有的功能，就需要更新次版本号；
• Z 表示补丁更新。当你只是简单的修复了BUG，没有做任何新功能的添加，或者旧功能的修改，就需要更新补丁；
• 此规则对包管理和使用非常重要，请严格按照规则执行。

.

七、npm上传白名单

在 package.json 文件添加如下代码，表示：

• 上传文件包括 src/ | demo/ | index.js
• 始终上传 README.md | package.json | LICENSE

"files": [
    "src",
    "demo",
    "index.js"
]

.

八、npm上传黑名单（忽略文件）

在项目根目录创建文件 .npmignore 忽略规则同 .gitignore。在这里定义的文件即使在白名单里存在，也同样会被忽略，如下： demo 文件夹下面的所有文件将会被忽略

/demo

.

九、npm包的删除与弃用

• 只有在发包的24小时内才允许撤销发布的包

  npm unpublish
  

• 弃用特定版本以及版本范围

  npm deprecate <pkg>[@<version>] <message>
  

.

十、发布npm包报错原因分析

1、没有package.json

package.json文件必须要有

2、项目版本号没有改变

• 可手动更改版本号
• 使用命令更新，如下：

npm version patch	//第三位增1。一共三位数字 "1.0.0"
npm version minor	//第二位增1
npm version major	//第一位增1

3、第一次发布npm包的时候，需要邮箱激活验证

.

系列文章

【node使用】发布一个自己的npm包
【node使用】搭建一个web服务器
【node使用】package.json详解以及package-lock.json的作用
【node使用】path模块
【node使用】glob匹配模式
【node使用】fs模块
【node使用】实现console输出不同颜色