0.背景
在工作中我们积累了一些自己的功能代码,例如克隆一个对象,数组去重等等。这些功能代码可以在其它项目中重复使用,此时我们就可以选择把代码打包放在npm上,在需要要使用的项目中,通过npm install去下载下来。
1.基本思路
- 源代码放在github上进行托管。
- 在本地下载代码,编辑代码,同步代码到github。打包上传到npm上,发布新版本。
2.目标
在npm上留下自己的package。
3.步骤
- 在github和npm上注册帐号。
- 在github上创建一个repository。设置repository name, description, 选择创建readme。这个仓库就用来保存你的源代码。假设仓库名是myNpm
- 在本地磁盘上,通过
git clone https://github.com/***/myNpm.git
命令,把github上的代码下载到本地。
4.在myNpm目录下,通过
npm init
命令来创建一个package.json文件,对你项目myNpm信息进行设置。
- 在myNpm下编写你的代码。此时你可以通过相关的git命令把你的代码同步到github上。常用的命令有:
git add .. /*把文件添加到本地版本库中*/
git commit -a -m '修改说明' /*把本次代码的改动保存到本地版本库中*/
git push /*把本地的版本库同步到远程代码库*/
git status /*查看当前的代码仓库的状态*/
git pull /*从远程仓库拉取代码到本地*/
也可以通过github客户端来管理代码。
- 通过 npm pack对代码进行打包
npm pack
这个命令会把代码打包成一个.tgz文件。你可以在文件系统中看到这个文件。
接下来,就要把这个.tgz文件上传到npm官网上去,供他人通过
npm install myNpm
来下载使用。
- 切换当前npm源到官网
由于我们需要把包上传到npm上,所以要先确保当前的npm源是npmjs.org
通过如下两条命令进行设置。
npm config get registry /*查看当前的npm的registry配置,确保是https://registry.npmjs.org*/
npm config set registry https://registry.npmjs.org /*手动设置registry*/
- 连接npm
npm adduser
这个命令需要输入三个信息:用户名,密码,邮箱。
你也可以通过如下命令检查自己是否连接成功了。
npm who am i
如果成功了,则可以最后一步了:publish
- 把包上传到npm
npm publish
出错的可能是:(1)这个包名被别人先用了。(2)包的版本号不对:每次publish时,包的版本号都应该要大于之前的版本号。
如果没有报错,则表示一切ok,你可以用你的帐号密码登陆npm,去查看你名下的package是否有了myNpm
- 通过npm install myNpm 下载使用。
查看包的源文件地址
其它
- 把npm源设置到常用的taobao镜像
npm config set registry https://registry.npm.taobao.org
- nrm 可以帮助我们去管理registry
npm install nrm -g
nrm ls /*列出所有可以供选择的镜像*/
nrm use taobao /*使用 taobao镜像 */
- 通过npm view myNpm 查看包的基本信息
- 通过npm view myNpm repository.url:
网友评论