agentleFS
qivora-labsqivora-labs/agentinit/.cursor/rules/tests.mdc

agentinit / rules

Cursor rule1 starsChanged 12 days agoMITView on GitHub

Testing conventions (unit tests, fixtures, snapshots, end-to-end runs)

The file

We split this tests.mdc into the rules it gives an agent

4 rules. About 0 are common, 1 is distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    PREFER table-driven tests (it.each) for pure modules.

    line 10
  2. Very specific:

    ALWAYS run filesystem tests in a temp directory (fs.mkdtemp) and clean up.

    line 11
  3. Very specific:

    ALWAYS snapshot generated files with toMatchFileSnapshot so diffs are reviewable.

    line 13
  4. Distinctive:

    NEVER make network calls in tests.

    line 16

≈ “Common” is an estimate: at least 1 in 5 of the 6,668 Cursor rule files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
tests.mdc
---
description: Testing conventions (unit tests, fixtures, snapshots, end-to-end runs)
globs: tests/**/*.ts
alwaysApply: false
---

# Tests

- Unit tests mirror `src/` (`src/registry/resolve.ts` → `tests/registry/resolve.test.ts`); end-to-end tests live in `tests/e2e/`.
- PREFER table-driven tests (`it.each`) for pure modules; name each case after the behavior it proves.
- ALWAYS run filesystem tests in a temp directory (`fs.mkdtemp`) and clean up; NEVER write inside the repo or a fixture.
- End-to-end tests copy a fixture to a temp dir and call `run([...args, '--cwd', dir])`; NEVER spawn the CLI unless the test is about the binary itself.
- ALWAYS snapshot generated files with `toMatchFileSnapshot` so diffs are reviewable; NEVER update snapshots without reviewing the diff.
- Fixtures are minimal but realistic; fake installed packages go in `tests/fixtures/<name>/node_modules/<pkg>/package.json` (committed on purpose).
- Inject time and prompts (fake `Prompter`) instead of mocking globals.
- NEVER make network calls in tests.

```ts
// ✅ Good: isolated, behavior-named, temp dir
it('keeps user content outside managed blocks byte-for-byte', async () => {
  const dir = await copyFixture('existing-claude-md');
  await run(['init', '--yes', '--cwd', dir]);
  expect(await readUserSection(dir)).toBe(original);
});

// ❌ Anti-pattern: runs in the fixture itself and mutates it
await run(['init', '--yes', '--cwd', 'tests/fixtures/existing-claude-md']);
```

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.