Comparison

A · Cursor rules · contentstack/contentstack-javascript B · AGENTS.md · contentstack/contentstack-javascript

What each file covers, counted
Dimension	Shared	Only in A	Only in B	Overlap
Sections	0	7	6	0%
Commands	0	0	6	0%
Section tags	2	5	4	18%

What each file covers

Sections

0 shared · 7 only in A · 6 only in B

− Code review checklist (CDA JavaScript SDK)
− Public API & documentation
− Backward compatibility
− Errors & safety
− Dependencies & supply chain
− Tests
− Security & privacy
+ Contentstack JavaScript Delivery SDK – Agent guide
+ What this repo is
+ Tech stack (at a glance)
+ Commands (quick reference)
+ Where the documentation lives: skills
+ Using Cursor (optional)

Commands

0 shared · 0 only in A · 6 only in B

+ npm run build
+ jest.js.config.js
+ jest.config.js
+ npm run lint
+ npm-publish.yml
+ npm test

Section tags

2 shared · 5 only in A · 4 only in B

− git-pr
− security
− dependencies
− api
− do-not
+ build
+ lint-format
+ code-style
+ agent-behaviour
test
docs

Line diff

+32 added−27 removed12 unchanged27.3% identical

contentstack/contentstack-javascript · .cursor/rules/code-review.mdc

@@ −1 @@

1---

2description: "PR review themes — API docs, compatibility, errors, security, tests (CDA SDK)"

3alwaysApply: true

4---

6# Code review checklist (CDA JavaScript SDK)

8Apply when reviewing changes to the **`contentstack`** npm package (Content Delivery API client).

10## Public API & documentation

12- **JSDoc** updated for new or changed public methods/classes (params, return shape, examples), matching style in `src/core/contentstack.js` / `src/core/stack.js`.

13- **`index.d.ts`** updated when TypeScript consumers would see different signatures or new exports.

15## Backward compatibility

17- Avoid breaking changes to exported function signatures, option objects, or default behavior without a major version rationale.

18- If behavior changes, ensure **callers inside `src/`** and tests reflect the new contract.

20## Errors & safety

22- HTTP failures should continue to reject with a predictable shape from **`src/core/lib/request.js`** where applicable (**`error_message`**, **`error_code`**, **`errors`**, **`status`**, **`statusText`**).

23- Do not log full **delivery_token**, **preview_token**, **management_token**, or **api_key** values.

24- Respect **null/undefined** edge cases for optional API fields.

26## Dependencies & supply chain

28- New **dependencies** should be justified (size, maintenance, license).

29- Lockfile and **`package.json`** version bumps should be minimal and reviewable.

31## Tests

33- **Jest** tests for new logic or regressions under **`test/`** (JS and/or **`test/typescript/`** as appropriate).

34- Live stack tests must remain compatible with **`test/config.js`** env requirements; document new env needs in **`test/README.md`** or comments near the harness — never commit credentials.

36## Security & privacy

38- No hardcoded credentials; no accidental exposure of customer content in logs or error messages.

contentstack/contentstack-javascript · AGENTS.md

@@ +1 @@

1# Contentstack JavaScript Delivery SDK – Agent guide

3**Universal entry point** for contributors and AI agents. Detailed conventions live in **`skills/*/SKILL.md`**.

5## What this repo is

7| Field | Detail |

8|--------|--------|

9| **Name:** | [contentstack-javascript](https://github.com/contentstack/contentstack-javascript) (npm package **`contentstack`**) |

10| **Purpose:** | Legacy **JavaScript** Content Delivery SDK for browsers, Node.js, React Native, and NativeScript—stack initialization, queries, entries, assets. |

11| **Out of scope:** | Not the TypeScript-first **`@contentstack/delivery-sdk`** (`contentstack-typescript`); new TypeScript projects should prefer that package when appropriate. |

13## Tech stack (at a glance)

15| Area | Details |

16|------|---------|

17| Language | JavaScript in **`src/`**; TypeScript tests via Jest (`test/typescript`) |

18| Build | Webpack configs under **`webpack/`**; outputs under **`dist/`** per target (`npm run build`) |

19| Tests | Jest: **`test:e2e`** (`jest.js.config.js`) and **`test:typescript`** (`jest.config.js`); **`pretest`** runs **`build`** first |

20| Lint / coverage | ESLint on `src` and `test` (`npm run lint`) |

21| CI | `.github/workflows/check-branch.yml`, `npm-publish.yml`, `sca-scan.yml`, `policy-scan.yml`, `codeql-analysis.yml`, `link-check.yml`, `issues-jira.yml` |

23## Commands (quick reference)

25| Command type | Command |

26|--------------|---------|

27| Build | `npm run build` |

28| Test | `npm test` (build via `pretest`, then e2e + TypeScript Jest suites) |

29| Lint | `npm run lint` |

31## Where the documentation lives: skills

33| Skill | Path | What it covers |

34|-------|------|----------------|

35| **Development workflow** | [`skills/dev-workflow/SKILL.md`](skills/dev-workflow/SKILL.md) | Branches, npm scripts, Husky, CI |

36| **JavaScript SDK** | [`skills/contentstack-javascript-sdk/SKILL.md`](skills/contentstack-javascript-sdk/SKILL.md) | Public API (`Stack`, regions), `@contentstack/utils` |

37| **JavaScript tooling** | [`skills/javascript/SKILL.md`](skills/javascript/SKILL.md) | Webpack targets, `dist/` layout, Babel |

38| **Testing** | [`skills/testing/SKILL.md`](skills/testing/SKILL.md) | Jest configs, e2e vs TypeScript tests |

39| **Code review** | [`skills/code-review/SKILL.md`](skills/code-review/SKILL.md) | PR checklist |

41## Using Cursor (optional)

43If you use **Cursor**, [`.cursor/rules/README.md`](.cursor/rules/README.md) only points to **`AGENTS.md`**—same docs as everyone else.

@@ −1 +1 @@

1−---

2−description: "PR review themes — API docs, compatibility, errors, security, tests (CDA SDK)"

3−alwaysApply: true

4−---

1+# Contentstack JavaScript Delivery SDK – Agent guide

6−# Code review checklist (CDA JavaScript SDK)

3+**Universal entry point** for contributors and AI agents. Detailed conventions live in **`skills/*/SKILL.md`**.

8−Apply when reviewing changes to the **`contentstack`** npm package (Content Delivery API client).

5+## What this repo is

10−## Public API & documentation

7+| Field | Detail |

8+|--------|--------|

9+| **Name:** | [contentstack-javascript](https://github.com/contentstack/contentstack-javascript) (npm package **`contentstack`**) |

10+| **Purpose:** | Legacy **JavaScript** Content Delivery SDK for browsers, Node.js, React Native, and NativeScript—stack initialization, queries, entries, assets. |

11+| **Out of scope:** | Not the TypeScript-first **`@contentstack/delivery-sdk`** (`contentstack-typescript`); new TypeScript projects should prefer that package when appropriate. |

1112

12−- **JSDoc** updated for new or changed public methods/classes (params, return shape, examples), matching style in `src/core/contentstack.js` / `src/core/stack.js`.

13−- **`index.d.ts`** updated when TypeScript consumers would see different signatures or new exports.

13+## Tech stack (at a glance)

1414

15−## Backward compatibility

15+| Area | Details |

16+|------|---------|

17+| Language | JavaScript in **`src/`**; TypeScript tests via Jest (`test/typescript`) |

18+| Build | Webpack configs under **`webpack/`**; outputs under **`dist/`** per target (`npm run build`) |

19+| Tests | Jest: **`test:e2e`** (`jest.js.config.js`) and **`test:typescript`** (`jest.config.js`); **`pretest`** runs **`build`** first |

20+| Lint / coverage | ESLint on `src` and `test` (`npm run lint`) |

21+| CI | `.github/workflows/check-branch.yml`, `npm-publish.yml`, `sca-scan.yml`, `policy-scan.yml`, `codeql-analysis.yml`, `link-check.yml`, `issues-jira.yml` |

1622

17−- Avoid breaking changes to exported function signatures, option objects, or default behavior without a major version rationale.

18−- If behavior changes, ensure **callers inside `src/`** and tests reflect the new contract.

23+## Commands (quick reference)

1924

20−## Errors & safety

25+| Command type | Command |

26+|--------------|---------|

27+| Build | `npm run build` |

28+| Test | `npm test` (build via `pretest`, then e2e + TypeScript Jest suites) |

29+| Lint | `npm run lint` |

2130

22−- HTTP failures should continue to reject with a predictable shape from **`src/core/lib/request.js`** where applicable (**`error_message`**, **`error_code`**, **`errors`**, **`status`**, **`statusText`**).

23−- Do not log full **delivery_token**, **preview_token**, **management_token**, or **api_key** values.

24−- Respect **null/undefined** edge cases for optional API fields.

31+## Where the documentation lives: skills

2532

26−## Dependencies & supply chain

33+| Skill | Path | What it covers |

34+|-------|------|----------------|

35+| **Development workflow** | [`skills/dev-workflow/SKILL.md`](skills/dev-workflow/SKILL.md) | Branches, npm scripts, Husky, CI |

36+| **JavaScript SDK** | [`skills/contentstack-javascript-sdk/SKILL.md`](skills/contentstack-javascript-sdk/SKILL.md) | Public API (`Stack`, regions), `@contentstack/utils` |

37+| **JavaScript tooling** | [`skills/javascript/SKILL.md`](skills/javascript/SKILL.md) | Webpack targets, `dist/` layout, Babel |

38+| **Testing** | [`skills/testing/SKILL.md`](skills/testing/SKILL.md) | Jest configs, e2e vs TypeScript tests |

39+| **Code review** | [`skills/code-review/SKILL.md`](skills/code-review/SKILL.md) | PR checklist |

2740

28−- New **dependencies** should be justified (size, maintenance, license).

29−- Lockfile and **`package.json`** version bumps should be minimal and reviewable.

41+## Using Cursor (optional)

3042

31−## Tests

32−

33−- **Jest** tests for new logic or regressions under **`test/`** (JS and/or **`test/typescript/`** as appropriate).

34−- Live stack tests must remain compatible with **`test/config.js`** env requirements; document new env needs in **`test/README.md`** or comments near the harness — never commit credentials.

35−

36−## Security & privacy

37−

38−- No hardcoded credentials; no accidental exposure of customer content in logs or error messages.

43+If you use **Cursor**, [`.cursor/rules/README.md`](.cursor/rules/README.md) only points to **`AGENTS.md`**—same docs as everyone else.

3944