mirror of
https://gitea.toothfairyai.com/ToothFairyAI/tf_code.git
synced 2026-04-01 06:42:26 +00:00
a8b73fd754
- Rename packages/opencode → packages/tfcode (directory only) - Rename bin/opencode → bin/tfcode (CLI binary) - Rename .opencode → .tfcode (config directory) - Update package.json name and bin field - Update config directory path references (.tfcode) - Keep internal code references as 'opencode' for easy upstream sync - Keep @opencode-ai/* workspace package names This minimal branding approach allows clean merges from upstream opencode repository while providing tfcode branding for users.
82 lines
2.0 KiB
Markdown
82 lines
2.0 KiB
Markdown
# Test Fixtures Guide
|
|
|
|
## Temporary Directory Fixture
|
|
|
|
The `tmpdir` function in `fixture/fixture.ts` creates temporary directories for tests with automatic cleanup.
|
|
|
|
### Basic Usage
|
|
|
|
```typescript
|
|
import { tmpdir } from "./fixture/fixture"
|
|
|
|
test("example", async () => {
|
|
await using tmp = await tmpdir()
|
|
// tmp.path is the temp directory path
|
|
// automatically cleaned up when test ends
|
|
})
|
|
```
|
|
|
|
### Options
|
|
|
|
- `git?: boolean` - Initialize a git repo with a root commit
|
|
- `config?: Partial<Config.Info>` - Write an `opencode.json` config file
|
|
- `init?: (dir: string) => Promise<T>` - Custom setup function, returns value accessible as `tmp.extra`
|
|
- `dispose?: (dir: string) => Promise<T>` - Custom cleanup function
|
|
|
|
### Examples
|
|
|
|
**Git repository:**
|
|
|
|
```typescript
|
|
await using tmp = await tmpdir({ git: true })
|
|
```
|
|
|
|
**With config file:**
|
|
|
|
```typescript
|
|
await using tmp = await tmpdir({
|
|
config: { model: "test/model", username: "testuser" },
|
|
})
|
|
```
|
|
|
|
**Custom initialization (returns extra data):**
|
|
|
|
```typescript
|
|
await using tmp = await tmpdir<string>({
|
|
init: async (dir) => {
|
|
await Bun.write(path.join(dir, "file.txt"), "content")
|
|
return "extra data"
|
|
},
|
|
})
|
|
// Access extra data via tmp.extra
|
|
console.log(tmp.extra) // "extra data"
|
|
```
|
|
|
|
**With cleanup:**
|
|
|
|
```typescript
|
|
await using tmp = await tmpdir({
|
|
init: async (dir) => {
|
|
const specialDir = path.join(dir, "special")
|
|
await fs.mkdir(specialDir)
|
|
return specialDir
|
|
},
|
|
dispose: async (dir) => {
|
|
// Custom cleanup logic
|
|
await fs.rm(path.join(dir, "special"), { recursive: true })
|
|
},
|
|
})
|
|
```
|
|
|
|
### Returned Object
|
|
|
|
- `path: string` - Absolute path to the temp directory (realpath resolved)
|
|
- `extra: T` - Value returned by the `init` function
|
|
- `[Symbol.asyncDispose]` - Enables automatic cleanup via `await using`
|
|
|
|
### Notes
|
|
|
|
- Directories are created in the system temp folder with prefix `opencode-test-`
|
|
- Use `await using` for automatic cleanup when the variable goes out of scope
|
|
- Paths are sanitized to strip null bytes (defensive fix for CI environments)
|