felix-react-native-wechat-sdk/PUBLISH_GUIDE.md

React Native WeChat SDK for authentication, payment and sharing

# 发布指南：React Native WeChat SDK

## 概述
本指南提供了如何将React Native WeChat SDK发布到公共npm仓库(www.npmjs.com)的详细步骤。

## 前提条件
在开始之前，请确保您已安装以下工具：
- [Node.js](https://nodejs.org/) (v14或更高版本)
- [npm](https://www.npmjs.com/) (v6或更高版本) 或 [Yarn](https://yarnpkg.com/)
- 访问您的内部npm仓库的权限

## 配置说明

### 1. package.json配置
项目的`package.json`已经配置了以下关键字段：

- `private: true` - 确保包不会被发布到公共npm仓库
- `main: "lib/index.js"` - 指定包的入口文件
- `types: "lib/index.d.ts"` - 指定TypeScript类型定义文件
- `scripts.build` - 用于编译TypeScript代码

### 2. .npmignore文件
项目包含`.npmignore`文件，用于指定不应发布到npm的文件和目录，包括：
- 源代码目录(`src/`) - 因为我们只发布编译后的代码
- 测试目录
- 文档目录
- 临时文件和构建缓存

## 发布步骤

### 1. 构建项目
在发布前，确保您已构建最新版本的代码：

```bash
# 使用npm
npm run build

# 或使用yarn
yarn build
```

### 2. 验证构建结果
检查`lib`目录，确保所有必要的文件都已正确生成：
- `index.js` - 编译后的JavaScript代码
- `index.d.ts` - TypeScript类型定义

### 3. 发布到公共npm仓库

```bash
# 首先，确保您已登录到npm账户
npm login

# 验证登录状态
npm whoami

# 然后发布包
npm publish
```

### 4. 在其他项目中使用
在需要使用此SDK的项目中，可以通过以下方式安装：

```bash
# 使用npm
npm install react-native-wechat-sdk

# 或使用yarn
yarn add react-native-wechat-sdk
```

## 版本管理
当您对SDK进行更改时，请遵循[语义化版本控制](https://semver.org/)原则更新`package.json`中的`version`字段：
- `MAJOR` 版本 - 不兼容的API更改
- `MINOR` 版本 - 向后兼容的功能性新增
- `PATCH` 版本 - 向后兼容的问题修正

## 注意事项

1. 发布到公共npm仓库后，任何人都可以下载使用这个包
2. 每次更改后都要重新构建和发布，并更新版本号
3. 保持版本号与更改的范围相匹配（遵循语义化版本控制）
4. 定期更新文档以反映最新的API变化
5. 确保代码质量和安全性，因为这将面向公众使用

## 常见问题

### Q: 为什么我无法安装这个包？
**A:** 确保您的npm配置正确，并且可以访问公共npm仓库(www.npmjs.com)。

### Q: 安装后，我遇到了平台特定的问题，如何解决？
**A:** 对于React Native包，可能需要执行额外的链接步骤。请参考React Native文档中的[原生模块集成指南](https://reactnative.dev/docs/native-modules-intro)。

### Q: 如何更新已发布的包？
**A:** 首先更新`package.json`中的`version`字段，然后重新构建并发布：
```bash
npm run build
npm publish
```

### Q: 如何撤销发布？
**A:** 您可以在发布后的72小时内撤销发布：
```bash
npm unpublish react-native-wechat-sdk@版本号 --force
```

注意：频繁撤销发布可能会影响您的npm账户信誉。