Skip to content

docs: a PowerShell script needs one more line, or a failed run reports success #40

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
donislawdev merged 2 commits into from
Sep 2, 2026
Merged

docs: a PowerShell script needs one more line, or a failed run reports success #40

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
92f2ff3
docs: a PowerShell script needs one more line, or a failed run report…
donislawdev Sep 2, 2026
6493ca0
docs: a relative output.dir is read from where you run, not from the …
donislawdev Sep 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -377,9 +377,12 @@ tfg generate fixtures.yaml
| `seed` | the number that makes a run repeatable. Same seed, same bytes |
| `defaults.label` | write the self describing label inside each file. Default `true` |
| `targets` | the list of things to produce. See below |
| `output.dir` | where the files and the manifest go |
| `output.dir` | where the files and the manifest go. A relative path is read from the directory you run in, not from the one the recipe sits in |
| `output.manifest` | manifest file name. Default `manifest.json` |

So a recipe kept in `recipes/` with `dir: out` writes into `out` next to you, not
next to the recipe. Give an absolute path, or `--out`, when you want it fixed.

### Target keys

| key | meaning |
Expand Down Expand Up @@ -590,6 +593,21 @@ An invalid recipe writes **no files at all** and reports every problem at once,
each naming the setting it is about. A run stopped with Ctrl+C still leaves a
manifest, and never leaves a half written file behind.

### A PowerShell script needs one more line

PowerShell does not carry the exit code of a program out of a `.ps1` file. Run
one with `-File` and the script answers `0` even when the tool inside refused
the work, so a build that should be red goes green:

```powershell
tfg generate fixtures.yaml --out ./fixtures
exit $LASTEXITCODE
```

That last line is the whole of it. This is how PowerShell behaves rather than
anything about this tool, which returns the code from the table above either
way. `cmd`, `bash` and `zsh` need nothing extra.

## ❓ Questions

### How is this different from `dd`, `fsutil` or `truncate`?
Expand Down
Loading