- Rust 99.7%
- JavaScript 0.2%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
| catalog | ||
| crates | ||
| docs | ||
| editors/zed | ||
| fixtures | ||
| tree-sitter-wfx | ||
| .gitignore | ||
| Cargo.lock | ||
| Cargo.toml | ||
| README.md | ||
wf: Büroware workflow scripts as text
wf lets you write Büroware (SoftENGINE) ERP workflow scripts as plain text files and bring them
back into the ERP through the Designer's normal import. It unpacks a Designer export (.DTK) into a
folder of editable files, checks them, previews their run, and packs them into a new .DTK. Untouched
content packs back byte for byte.
| Part | Crate / folder |
|---|---|
wf command line |
crates/workflow-cli |
Language server workflow-lsp |
crates/workflow-lsp |
| Zed extension and grammar | editors/zed, tree-sitter-wfx |
| Libraries | workflow-dtk (page files), workflow-script (workflow model), workflow-lang (.wfx syntax, analysis, lints), workflow-pack (unpack/pack), workflow-eval (preview runs) |
Manual
The full documentation is an mdBook in docs/book:
mdbook serve docs/book --open
| Topic | Page |
|---|---|
| Installation, ERP user, catalog | setup/install.md |
| Zed setup | setup/zed.md |
| Designer, workflows, events, build numbers | concepts/erp.md |
| Unpack, edit, pack, import | guide/unpack-pack.md |
workflow.toml ([table], [[events]]) |
guide/workflow-toml.md |
fields.toml |
guide/fields.md |
The .wfx language |
guide/wfx.md |
| Lint codes | guide/lint.md |
| Editor features | guide/editor.md |
Preview runs (wf run) |
guide/preview.md |
| Relation catalog, ERP versions | guide/catalog.md |
| Every command and flag | reference/cli.md |
| Errors and fixes | reference/troubleshooting.md |
| Repository, tests, research | development/repo.md |
Quickstart
cargo install --path crates/workflow-cli # wf
cargo install --path crates/workflow-lsp # language server (for Zed)
wf unpack EXPORT.DTK my-export/ # one folder per workflow, one .wfx per event
# edit my-export/WF0001/events/*.wfx, workflow.toml, fields.toml
wf lint my-export/
wf pack my-export/ --user 105 -o NEW.DTK # 105 = your ERP user number (or $WF_USER)
Then import NEW.DTK in the Designer. pack raises the build number of every changed workflow;
the import only replaces a workflow whose build is higher than the ERP's.
Development
cargo test --workspace
cargo clippy --workspace --all-targets -- -D warnings
cargo fmt --all --check
Real ERP exports never go into the repository; the fixtures in fixtures/ are synthetic test
exports. Details: development/testing.md. Open tasks and the
state of the project: docs/handover.md. Reverse-engineering notes: docs/re/.