react-native-typescript-library-starter: Instructions file for Codex

AGENTS.md — AI Agent Instructions

This file provides context for AI agents (Cursor, Claude, Copilot, etc.) working on this repository. Read it in full before making any changes.

Project Overview

react-native-typescript-library-starter is a React Native TypeScript library starter template. It is NOT an application — it is a publishable npm package used as a starting point for building React Native component/hook libraries.

• Build tool: react-native-builder-bob (outputs CJS + ESM + TypeScript declarations)
• Testing: Jest + @testing-library/react-native
• Language: TypeScript (strict mode, no any)
• Linting: oxlint v8 + oxfmt
• CI: GitHub Actions (typecheck + lint + test + build)

Directory Map

react-native-typescript-library-starter/
├── src/                          # ALL library source code lives here
│   ├── index.ts                  # Public API — only export from here
│   ├── components/
│   │   └── MyComponent/
│   │       ├── MyComponent.tsx        # Implementation
│   │       ├── MyComponent.types.ts   # Props interface
│   │       └── index.ts               # Barrel export
│   ├── hooks/
│   │   └── useMyHook.ts          # Custom hook with TSDoc
│   ├── types/
│   │   └── index.ts              # Shared utility types
│   └── __tests__/
│       ├── MyComponent.test.tsx
│       └── useMyHook.test.ts
├── lib/                          # GENERATED by bob — do NOT edit manually
│   ├── commonjs/                 # CJS output
│   ├── module/                   # ESM output
│   └── typescript/               # .d.ts declarations
├── scripts/
│   └── terminal/
│       ├── lint.mjs              # Colored oxlint runner
│       └── oxfmt.mjs          # Colored oxfmt runner
├── .github/
│   └── workflows/
│       ├── ci.yml                # Runs on PR: typecheck + lint + test + build
│       └── release.yml           # Runs on push to main: release pipeline
├── .husky/                       # Git hooks (pre-commit, commit-msg)
├── AGENTS.md                     # This file
├── CONTRIBUTING.md
├── CHANGELOG.md
├── README.md
├── package.json                  # bob config, jest config, lint-staged config
├── tsconfig.json                 # Base TypeScript config
├── tsconfig.build.json           # bob-specific build config
├── babel.config.js               # metro-react-native-babel-preset (for Jest)
├── .oxlintrc.json
├── .oxfmtrc.json
└── .commitlintrc.json