如何发布一个属于自己的npm包

559 阅读2分钟

1. 准备

前往npm官网注册一个账号

2. 创建一个简单的包

(1). 在本地创建一个项目文件夹(名字自己取,但是不能和已有的包重复,建议取名之前先去搜索一下有没有叫这个名字的包存在)

(2). 初始化项目,生成package.json

npm init

package.json:

{
  "name": "gwy_package",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [],
  "author": "",
  "license": "ISC"
}

(3). 新建一个index.js入口文件,在里面写上代码,示例:

/**
 * 正则判断当前设备是否为手机
 * @returns {boolean}
 */
export function isMobile() {
    return /Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent)
}

/**
 * 正则判断当前设备是否为Mac
 * @returns {boolean}
 */
export function isMac() {
    return /macintosh|mac os x/i.test(navigator.userAgent)
}

/**
 * 正则判断当前设备是否为安卓
 * @returns {boolean}
 */
export function isAndroid() {
    return /android/i.test(navigator.userAgent)
}

/**
 * 正则判断当前设备是否为IOS
 * @returns {boolean}
 */
export function isIOS() {
    return /iPad|iPhone|iPod/.test(navigator.userAgent) && !window.MSStream
}

到这里一个简单的包就创建好了,还可以在包根目录下创建README.md文件,里面可以写一些关于包的介绍信息

3. 发布

(1). 如果是第一次发布包,需要在控制台输入以下命令,然后输入前面注册好的npm账号,密码和邮箱,将提示创建成功:

npm adduser

如果不是第一次发布包,执行以下命令进行登录,同样输入NPM账号,密码和邮箱:

npm login

(2).接着先进入项目文件夹下,然后输入以下命令进行发布

npm publish

如果提示以下信息就说明发布成功了:

+ gwy_package@1.0.0

如果提示以下信息,发布失败,说明这个包名已经有人使用了:

npm ERR publish 403

You do not have permission to publish 'first_package'.Are you logged in as
the corrent user?:first_package

4. 更新包

更新包的操作和发布包的操作其实是一样的:

npm publish

但是需要注意的是,每次更新时,必须修改版本号才能更新,比如将1.0.0修改为1.0.1后就能进行更新发布

5. 撤销已经发布的包

npm unpublish 包名 --force

注意:取消发布包不像想象的那么简单,假设你包已经有很多人在用,你撤销以后对别人的影响是巨大的,所以撤销请慎重。

如果这篇文章对你有帮助,请点个赞再走吧