npm发布流程

最近在玩hexo,自己写了一个hexo d提交版本库后,ssh连接远程服务器拉取的js包,自己手动放到node_modules的话更新就没有了,于是就想到了发布到npm上。

流程

  • 在GitHub上创建一个项目(如:hexo-zngw-sshpull)
  • 克隆(git clone)到本地
  • npm初始化(npm init)
  • 注册npm账号及登录npm(如果您没有npm账号的话)
  • 命令行登录npm账号
  • npm包发布(npm publish --access=public)
  • npm包版本更新
  • 删除包(如果你想作死的话)

1. 创建 GitHub 项目

npm创建时依赖于一个git仓库,所以我们先在github上创建一个项目,并克隆到本地
如: https://github.com/zngw/hexo-zngw-sshpull

2. npm 初始化

打开命令行窗口,进入git仓库项目目录

npm init

按照提示完成类似以下内容的输入:

Press ^C at any time to quit.
package name: (hexo-zngw-sshpull)
version: (1.0.0)
description: hexo发布时,通过ssh连接远程服务器自动git pull
entry point: (index.js)
test command: hexo发布时,通过ssh连接远程服务器自动git pull
git repository: (https://github.com/zngw/hexo-zngw-sshpull.git)
keywords: hexo发布时,通过ssh连接远程服务器自动git pull
author: zngw
license: (ISC)

说明:

配置项 功能
package name 项目名称(要求在npm官网具有唯一性,不允许有大写字母,通常由字母,中横线,@符号组成)
version 版本号(要求每次npm publish前修改,必须大于之前的版本)
description 项目描述信息(这个可以随便写点关于项目的介绍信息)
entry point 入口文件,通常用index.js
test command 测试命令,执行npm run test命令时的输出信息或命令
git repository 项目的GitHub地址,会在npm官网添加该项目的GitHub链接
keywords 关键词(在npm官网搜索专用关键词,能够增加搜索效率)
author 作者(请写上您的大名,让别人认识你)
license 版权,权限(默认ISO就行)

3. 注册npm账号

用浏览器打开npm官网https://www.npmjs.com/,点击sign up注册,点击log in登录
注意: 想要发布npm包需要上述注册信息,务必牢记注册名称,密码及邮箱(例如账号:zngw,密码:xxxxxx,邮箱:[email protected])。
** PS: ** 注册后记得去邮箱里验证一下,不然后面提交的时候会报错的

npm ERR! code E403
npm ERR! 403 Forbidden - PUT https://registry.npmjs.org/hexo-zngw-sshpull - you must verify your email before publishing
 a new package: https://www.npmjs.com/email-edit

npm ERR! A complete log of this run can be found in:
npm ERR!     C:\Users\Administrator\AppData\Roaming\npm-cache\_logs\2020-03-23T17_56_28_029Z-debug.log

4. 命令行登录npm账号

在前面初始化npm的命令窗口中登录

F:\work\MyGithub\hexo-zngw-sshpull>npm login
Username: zngw
Password:
Email: (this IS public) [email protected]
Logged in as zngw on https://registry.npmjs.org/.

5. 准备发布包

这里就是编写你的程序和代码,如果有依赖别的包,可以直接在package.json中添加,如

  "dependencies": {
    "ssh2": "^0.8.9"
  },

6. 发布npm包

首次发布命令:

npm publish --access=public

如果项目重名会发不成功,这时候修改package.json里的name保证唯一就可以了

F:\work\MyGithub\hexo-zngw-sshpull>npm publish --access=public
npm notice
npm notice package: [email protected]
npm notice === Tarball Contents ===
npm notice 639B  package.json
npm notice 72B   index.js
npm notice 83B   README.md
npm notice 1.5kB lib/sshpull.js
npm notice === Tarball Details ===
npm notice name:          hexo-zngw-sshpull
npm notice version:       1.0.0
npm notice package size:  1.1 kB
npm notice unpacked size: 2.3 kB
npm notice shasum:        7d402750ecae49460f4614aff53fb1b215d436b6
npm notice integrity:     sha512-QtFZ3cUjVrGN+[...]+JDMfYySE83wA==
npm notice total files:   4
npm notice
+ [email protected]

7. npm包版本更新

需要修改package.json文件中的version信息,只要增加就行了,中间随便怎么跳版本
然后npm publish发布

F:\work\MyGithub\hexo-zngw-sshpull>npm publish
npm notice
npm notice package: [email protected]
npm notice === Tarball Contents ===
npm notice 685B  package.json
npm notice 72B   index.js
npm notice 908B  README.md
npm notice 1.5kB lib/sshpull.js
npm notice === Tarball Details ===
npm notice name:          hexo-zngw-sshpull
npm notice version:       1.0.2
npm notice package size:  1.5 kB
npm notice unpacked size: 3.2 kB
npm notice shasum:        9626b75d94d0422696a00ab2b72277a259e75cc6
npm notice integrity:     sha512-NmT/0Ag13AWcy[...]i8yQ44fPW2AVA==
npm notice total files:   4
npm notice
+ [email protected]

8. 删除包

npm unpublish 依赖包名称 --force

本文参考:https://github.com/loushengyue/test-projects

你可能感兴趣的:(npm发布流程)