一个npm包的基本操作—发布、更新、删除

一个npm包的基本操作—发布、更新、删除

发布npm包

1.注册npm账户

可以通过npm官方网址去注册

注册网址

也可以通过命令行注册

npm adduser

按照提示输入账号,密码和邮箱,然后将提示创建成功

2.登录

登录命令:

npm login 

按照提示输入刚刚注册的用户名、密码和邮箱即可

可以使用命令查看当前用户

npm whoani

【注意】npm adduser成功的时候默认你已经登陆了,所以不需要再接着npm login

3.创建npm包

创建命令:

npm init

初始化npm包的基本信息

Press ^C at any time to quit.
package name:  
version: (1.0.0) 
description: 
entry point: (index.js) 
test command:
git repository:
keywords:
author:
license: (ISC)
  • package name

    npm包名

  • version

    npm包版本号

  • description

    npm包相关描述

  • entry point

    npm包入口文件

  • test command

    npm包的测试命令

  • git repository

    npm的git地址

  • keywords

    npm包的关键字,方便搜索

  • author

    npm包的作者

  • license

    npm包遵循的开源协议)

设置完了之后会生成一个package.json的文件

4.发布npm包

命令:

npm publish

成功之后可以在 npm官网 搜搜到自己的包

【注意】

  • 发布的包名不能和已有的包的名字重名

  • npm对包名的限制:不能有大写字母/空格/下滑线

  • 如果有不想发布的文件,可以写入.gitignore 或.npmignore中

更新npm包

1.版本控制

npm包如果要更新的话,首先得先更改npm包的版本号,即package.json里的version字段,这里就涉及到版本控制

npm有一套自己的版本控制标准——Semantic versioning(语义化版本)

npm 的版本号由三部分组成: 主版本号次版本号补丁版本号。变更不同的版本号,代表不同的意义:

  • 主版本号(major):软件做了不兼容的变更(breaking change 重大变更)

  • 次版本号(minor):添加功能或者废弃功能,向下兼容

  • 补丁版本号(patch):bug 修复,向下兼容

可以通过修改package.json里的version字段去改变版本号也可以通过命令行改变版本号

npm version patch
npm version minor
npm version major

2.npm包更新

更新命令与发布命令是一样的

npm publish

删除npm包

撤销发布的npm包是不被鼓励支持的行为,也是会受到一些限制的行为

一般使用下面的删除命令都会提示拒绝删除

npm unpublish <pkg>
npm ERR! Refusing to delete entire project.
npm ERR! Run with --force to do this.
npm ERR! undefined

所以需要加上–force

npm unpublish --force

相比上面这个命令,推荐的代替命令是

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

使用这个命令,并不会在社区里撤销你已有的包,但会在任何人尝试安装这个包的时候得到版本作废的警告信息