Cursor rule

1---
2description: "Jest e2e and TypeScript tests for the CDA SDK"
3globs:
4  - "test/**/*.js"
5  - "test/**/*.ts"
6alwaysApply: false
7---
8 
9# Testing — `contentstack` (CDA)
10 
11## Frameworks
12 
13| Suite | Runner | Notes |
14|-------|--------|--------|
15| **JS e2e / integration-style** | **Jest** (`jest.js.config.js`) | `testMatch`: `**/test/**/*.js`; ignores `test/index.js`, `test/config.js`, `test/sync_config.js`, some `utils.js` paths |
16| **TypeScript** | **Jest** + **ts-jest** (`jest.config.js`) | `npm run test:typescript`; `test/typescript/**/*.test.ts` |
17 
18## Env & live stack
19 
20- **Canonical required vars** for suites that `require('./config')` or `require('../config.js')`: **`HOST`**, **`API_KEY`**, **`DELIVERY_TOKEN`**, **`ENVIRONMENT`** — validated in **`test/config.js`** (loads **dotenv**). Missing any variable throws on import.
21- Use a **`.env`** file locally; do not commit secrets. **`HOST`** should match the delivery API host for your stack/region.
22- Built SDK: many tests **`require('../../dist/node/contentstack.js')`**. **`npm test`** runs **`pretest`** → **`npm run build`** first.
23 
24## Layout
25 
26- **Suite entry (JS):** `test/index.js` `require`s individual test files.
27- **TypeScript:** colocate under **`test/typescript/`** with `*.test.ts` naming.
28 
29## Hygiene
30 
31- No committed **`only`** / **`skip`** for tests that must run in CI.
32- Prefer deterministic assertions; mock or scope live tests when adding new cases so CI behavior stays predictable if env is absent.
33 
34## Coverage
35 
36- Jest / reporter config is in **`jest.js.config.js`** and **`jest.config.js`**; HTML reports paths are configured there.
37