RN Primitives 项目使用教程
1. 项目目录结构及介绍
RN Primitives
是一个提供无样式、可访问的 React Native 组件的开源项目。项目目录结构如下:
rn-primitives/
├── .github/ # GitHub 相关配置文件
├── .vscode/ # VSCode 编辑器配置
├── apps/ # 应用的示例代码
├── packages/ # RN Primitives 组件包
├── patches/ # 补丁文件
├── .gitignore # Git 忽略文件
├── .npmrc # npm 配置文件
├── .nvmrc # nvm 配置文件
├── LICENSE # MIT 许可证文件
├── README.md # 项目自述文件
├── package.json # 项目配置文件
├── pnpm-lock.yaml # pnpm 锁文件
├── pnpm-workspace.yaml # pnpm 工作空间配置文件
├── turbo.json # Turborepo 配置文件
.github/
:包含 GitHub Actions 工作流和其他 GitHub 相关配置。.vscode/
:包含 Visual Studio Code 编辑器的配置文件。apps/
:包含使用 RN Primitives 组件的示例应用代码。packages/
:包含 RN Primitives 的核心组件包。patches/
:包含用于修复或更新依赖库的补丁文件。.gitignore
:指定 Git 忽略跟踪的文件和目录。.npmrc
:npm 的配置文件,用于设置 npm 的行为。.nvmrc
:nvm 的配置文件,用于指定 Node.js 的版本。LICENSE
:项目的 MIT 许可证。README.md
:项目的自述文件,包含项目介绍和如何使用的信息。package.json
:项目的配置文件,包含项目依赖和脚本。pnpm-lock.yaml
:pnpm 的锁文件,用于确保依赖的一致性。pnpm-workspace.yaml
:pnpm 的工作空间配置文件,用于管理多个包。turbo.json
:Turborepo 的配置文件,用于优化 monorepo 的构建和测试。
2. 项目的启动文件介绍
项目的启动主要是通过 package.json
文件中的脚本实现的。以下是一些关键的启动脚本:
pnpm dev:primitives
:构建并监视所有的 primitive 包。当 primitive 文件发生变化时,它将自动重新构建,无需手动运行构建命令。pnpm dev:expo-nativewind
:启动 Expo NativeWind 应用。pnpm dev:nextjs-nativewind
:启动 Nextjs NativeWind 应用。pnpm dev:docs
:启动文档应用。
3. 项目的配置文件介绍
项目的配置文件主要涉及以下几个方面:
package.json
:这是项目的主要配置文件,其中定义了项目的依赖、脚本和元数据。在scripts
部分,你可以找到用于启动开发服务器、构建项目、测试和运行其他任务的脚本。pnpm-lock.yaml
和pnpm-workspace.yaml
:这两个文件用于管理项目的依赖和 monorepo 结构。pnpm-lock.yaml
确保每次安装依赖时都能保持一致性,而pnpm-workspace.yaml
用于定义工作空间的布局和配置。turbo.json
:这个文件用于配置 Turborepo,它是一个用于优化 JavaScript monorepos 的工具。它可以减少构建和测试的时间,特别是在大型项目中。