# Fs Fixture

> Guides fs-fixture test setup. Use when tests need disposable files, directories, copied templates, symlinks, or automatic cleanup with createFixture().

- Skill: `tuyv/fs-fixture` (Agent Skill, multi-file: 4 files)
- Install (CLI): `npx skillmds@latest add tuyv/fs-fixture`
- Raw SKILL.md: https://api.skillmd.com/api/skills/tuyv/fs-fixture/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Coding & Dev Tools
- Author: tuyv (https://skillmd.com/u/tuyv)
- Updated: 2026-09-17
- Page: https://skillmd.com/skills/tuyv/fs-fixture

---


# fs-fixture

Use `fs-fixture` for tests that need realistic files or directories on disk.

## Reference

Read the local README before using less common options or APIs:

```text
node_modules/.pnpm/fs-fixture@2.8.1/node_modules/fs-fixture/README.md
```

If the exact pnpm store path changes, locate it with:

```sh
fd -a README.md node_modules/.pnpm | rg "fs-fixture"
```

## Default Pattern

Prefer `await using` so cleanup is automatic:

```ts
import { createFixture } from 'fs-fixture';

await using fixture = await createFixture({
	'projects/example/session.jsonl': '{}\n',
});

const filePath = fixture.getPath('projects/example/session.jsonl');
```

## Notes

- Use object trees for small inline fixtures.
- Use template directory input when many tests share the same larger fixture shape.
- Use `fixture.getPath(...)` instead of manually joining against `fixture.path`.
- Use `fixture.writeFile()` or `fixture.writeJson()` when a test needs to build data incrementally.
- Use `templateFilter` when copying only part of a template directory.