Skip to content

docs: add AGENTS.md with Cursor Cloud development instructions #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
rishabhyadavv wants to merge 1 commit into
base: main
Choose a base branch
from
+22 −0
Draft

docs: add AGENTS.md with Cursor Cloud development instructions #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# AGENTS.md

## Cursor Cloud specific instructions

This is a **React Native Turbo Module library** (`rn-encryption`) providing cross-platform encryption (AES, RSA, ECDSA, SHA, HMAC, Base64, file encryption). It is **not a standalone application** — the `example/` directory contains a React Native example app for on-device testing, but the library itself is the primary development target.

### Key development commands

All commands are documented in `CONTRIBUTING.md` and `package.json` scripts. Quick reference:

- `yarn lint` — ESLint (0 errors expected; 2 inline-style warnings in example app are pre-existing)
- `yarn typecheck` — TypeScript type-checking
- `yarn test` — Jest unit tests
- `yarn prepare` — Build the library (CJS, ESM, TS declarations, codegen) via `react-native-builder-bob`

### Environment notes

- **Node.js v18** is required (see `.nvmrc`). Use `nvm use 18` before running commands.
- **Yarn 3.6.1** (Berry) is bundled in `.yarn/releases/yarn-3.6.1.cjs`. Do not use npm.
- The example app (`example/`) requires iOS/Android SDKs and simulators/emulators which are not available in the Cloud Agent VM. Library-level verification (lint, typecheck, test, build) is sufficient for CI-like validation.
- The `web-secure-encryption` dependency provides the web implementation and can be exercised in Node.js by polyfilling `globalThis.crypto` with `require('crypto').webcrypto`.
- Pre-commit hooks are configured via `lefthook.yml` (runs lint + typecheck on staged files).