@flowwright/plugin-std
v0.1.1
Published
FlowWright shared library — standard reusable steps (cleanWs, deleteDir, checkout, writeFile, stash).
Readme
@flowwright/plugin-std
The everyday workspace helpers you reach for (cleanWs, deleteDir, checkout, …) —
real, typed imports from a versioned npm package instead of magic step names.
Every helper is a thin wrapper over @flowwright/core primitives, so each call is recorded
into the execution-plan IR and shows up in flow explain, the graph, and CI export. Nothing
happens behind your back.
Usage
Call the helpers inside a stage body:
import { pipeline, stage } from "@flowwright/core";
import { cleanWs, deleteDir, checkout } from "@flowwright/plugin-std";
export default pipeline({
name: "build",
stages: [
stage("Checkout", async () => {
await checkout("[email protected]:acme/app.git", { ref: "main", depth: 1 });
}),
stage("Build", { needs: ["checkout"], run: async () => { /* … */ } }),
],
// run cleanup no matter what — see the post/always lifecycle
post: { always: async () => { await cleanWs(); } },
});Helpers
| Helper | What it does |
|---|---|
| cleanWs() | Empties the working directory (keeps the dir, removes all entries incl. dotfiles). |
| deleteDir(path) | rm -rf a path. |
| checkout(url, { ref?, dir?, depth?, submodules?, fetchTags? }) | Clone a repo, then optionally check out a ref. Re-exported from @flowwright/plugin-git. |
| gitCheckout(ref) | git checkout <ref> in the current tree. Re-exported from @flowwright/plugin-git. |
| gitClone(url, dir?) | git clone into dir. Re-exported from @flowwright/plugin-git. |
