From 8ef9528305f21f8b3dd30391d82d879c53417b0f Mon Sep 17 00:00:00 2001 From: Cursor Agent Date: Sat, 16 May 2026 23:14:59 +0000 Subject: [PATCH] docs: add AGENTS.md with Cursor Cloud development instructions Co-authored-by: Rishabh Yadav --- AGENTS.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..4b27046 --- /dev/null +++ b/AGENTS.md @@ -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).