发布 ReactNative 组件到 NPM

时间 2019-11-17

标签发布 reactnative 组件 npm 繁體版

原文原文链接

原文地址：http://liu-hang.cn/2019/06/25/189-publish-react-native-component-to-npm/react

截屏捕捉组件

npm i react-native-screenshotcatch
复制代码

背景

前一段时间写的 react-native 截屏监听功能是直接写进项目中的，如今打算将其单独封装发布到 NPM 上去，以前也发过一个命令行工具可是没有写文记录一下过程，此次补上android

实现

使用 react-native-create-library

react-native-create-library 是一个自定义组件模板工具，比本身去建立省不少麻烦ios

npm i -g react-native-create-library # 安装
react-native-create-library --package-identifier com.dreamser.screenshotcatch --platforms android,ios screenshotcatch
mv screenshotcatch react-native-screenshotcatch
复制代码

更新 build.gradle

react-native-create-library 中的依赖版本过低，须要更新一下git

编写代码

请见 React Native 实现截图添加二维码分享功能github

完善 readme

react-native-create-library 已经为你准备了基础的模板，具体内容须要本身来添加shell

上传 github

初始化本地repo，在github建立远程repo，链接，上传代码...在这里不作赘述npm

完善 package.json

package.json文件定义了发布的全部信息，包括：组件名、版本、做者、描述、依赖等等关键信息。具体能够参照 Creating a package.json filejson

{
  "name": "react-native-screenshotcatch",
  "version": "0.0.1",
  "description": "A ReactNative Tool for catch Screen Shot Event",
  "main": "index.js",
  "scripts": {
    "test": "echo \"Error: no test specified\" && exit 1"
  },
  "keywords": [
    "react-native",
    "screen-shot",
    "screen-capture",
    "ios",
    "android"
  ],
  "author": {
    "name": "callcter",
    "email": "sharpliuzigu@gmail.com"
  },
  "license": "MIT",
  "repository": {
    "type": "git",
    "url": "git@github.com:callcter/react-native-screenshotcatch.git"
  },
  "peerDependencies": {
    "react-native": "^0.41.2"
  }
}
复制代码

发布到 NPM

npm adduser # 建立 NPM 帐号
npm login # 若是已经在官网有帐号，能够直接登陆
npm whoami # 查看登陆状态
npm publish # 发布
复制代码

发布时可能遇到 publish Failed PUT 403 错误，缘由是更改了镜像源react-native

npm config get registry # 查看当前镜像源
npm config set registry=http://registry.npmjs.org # 更改回官方镜像源
npm publish # 从新发布
复制代码

NPM 更新

npm 提供官方提供了npm version来进行版本控制，其效果跟手动修改package.json里面的version字段是同样的，好处在于，能够在构建过程当中用npm version命令自动修改，并且具备语义化即Semantic versioningbash

npm version [<newversion> | major | minor | patch | premajor | preminor | 
prepatch | prerelease | from-git]
复制代码

语义为：

major：主版本号（大版本）
minor：次版本号（小更新）
patch：补丁号（补丁）
premajor：预备主版本
preminor: 预备次版本
prepatch：预备补丁版本
prerelease：预发布版本
复制代码