发布npm包的方法

在做react-native开发的时候,我们经常会找到一些第三方组件,并且通过npm install的方式很方便的安装使用。我们也可以开发并发布组件,给自己或开源给他人使用。发布npm包的过程实际上就是把你本地的node 项目上传,供别人使用的过程, 和iOS中的Cocoapods, Android使用的maven有异曲同工之妙。

一、初始化一个项目

1、创建一个文件夹:yyy-npm-test
2、在终端执行:cd yyy-npm-test
3、在终端执行npm init , 然后一直回车直到结束

如下
Press ^C at any time to quit.
package name: (yyy-tool) 
version: (1.0.0) 
description: 
entry point: (index.js) 
test command: 
git repository: 
keywords: 
author: 
license: (ISC) 
About to write to /Users/admin/Desktop/yyy-    tool/package.json:

{
  "name": "yyy-tool",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
   },
  "author": "",
  "license": "ISC"
}
Is this OK? (yes) 
以上字段的涵义:
name:发布的包名,默认是上级文件夹名。不得与现在npm中的包名重复。包名不能有大写字母/空格/下滑线!
version:你这个包的版本,默认是1.0.0。对于npm包的版本号有着一系列的规则,模块的版本号采用X.Y.Z的格式,具体体现为:
  1、修复bug,小改动,增加z。
  2、增加新特性,可向后兼容,增加y
  3、有很大的改动,无法向下兼容,增加x
description:项目简介
mian:入口文件,默认是Index.js,可以修改成自己的文件 
scripts:包含各种脚本执行命令
test:测试命令
author:自己的账号名
license:这个直接回车,开源文件协议吧,也可以是MIT,看需要吧。

4、 在yyy-npm-test文件夹中创建一个index.js文件,简单写点内容。

如下
 !function(){
  console.log(`这是入口`)
}()
二、创建/登陆npm registry账户
npm registry是什么?

npm registry 相当于一个包注册管理中心。它管理着世界开发者们发布的各种插件,同时开发者们可以通过npm install 的方式安装插件。

查看当前使用的registry的方法:
$ npm config get registry

如果是https://registry.npm.taobao.org/

可用下面的命令切换
npm config set registry https://registry.npmjs.org/
在后面发布完成后可切换回来
npm config set registry http://registry.npm.taobao.org/

在终端输入npm adduser,提示输入账号,密码和邮箱,然后将提示创建成功。

如果你已经在官网注册了,那可以通过 npm login 登录npm registry账户

三、发布

首次发布的话,直接执行
$ npm publish

如果失败,可执行npm publish --access public

出现下面的图片则发布成功


image.png
四、查询发布的包

到官网https://www.npmjs.com/上全局搜索

image.png
五、本地代码测试

在组件未发布之前,我们可以直接安装本地代码到实际的项目(xxx)中进行测试,有以下几种方式都可以做到

yarn link
cd yyy-npm-test
yarn link
cd ../xxx
yarn link yyy-npm-test
说明:
1、yarn link是把当前目录中的本地代码用yarn注册为 yyy-npm-test的一个本地组件,组件名字 yyy-npm-test其实是根据package.json中的name字段的值来的,跟目录名无关,只不过这里正好等于目录名。
2、yarn link yyy-npm-test命令是把这个本地组件yyy-npm-test安装到了xxx的项目中,你可以在xxx/node_modules中找到这个组件。
3、其实yarn link这种方式简单来说,就是做了一个symbol link,也就是说,xxx/node_modules/yyy-npm-test/目录中的内容是指向yyy-npm-test/目录内容,你改动yyy-npm-test/目录下的代码,相当于直接改动xxx/node_modules/yyy-npm-test/这个目录中的代码,这样就能够达到边修改组件代码边看效果的目的了。
直接copy本地代码

直接copy yyy-npm-test/目录中内容到xxx/node_modules/yyy-npm-test/这个目录中
cp -rf yyy-npm-test/xxx/node_modules/

这种方式缺点就是每次在yyy-npm-test改完代码后,需要手工copy到xxx/node_modules/yyy-npm-test/。

六、撤销发布的包

如果想要撤销发布的包
可以执行npm unpublish 命令

例如:
npm unpublish [email protected]  删除某个版本

npm unpublish yyy-npm-test --force 删除整个npm市场的包
image.png

【注意】:如果报权限方面的错,加上--force

再次搜索如图(https://www.npmjs.com/):

image.png

你可能感兴趣的:(发布npm包的方法)