|
| 1 | +# OrgScript v0.4.0 |
| 2 | + |
| 3 | +OrgScript v0.4.0 is the first developer-experience release. |
| 4 | + |
| 5 | +This release moves the project from a stable language/tooling core toward a more usable day-to-day workflow with combined quality checks, documented machine-readable diagnostics, visible downstream exports, and the first usable editor integration. |
| 6 | + |
| 7 | +## Highlights |
| 8 | + |
| 9 | +- canonical formatting checks via `format --check` |
| 10 | +- one-command quality verification via `check` |
| 11 | +- stable diagnostics with documented codes and JSON output |
| 12 | +- Markdown summary export |
| 13 | +- Mermaid demos for process and stateflow visualization |
| 14 | +- canonical language spec, governance notes, and usage guides |
| 15 | +- first usable VS Code syntax-highlighting extension for `.orgs` |
| 16 | + |
| 17 | +## CLI and DX |
| 18 | + |
| 19 | +- Added `orgscript format <file> --check` |
| 20 | +- Added `orgscript format <file> --check --json` |
| 21 | +- Added `orgscript check <file>` |
| 22 | +- Added `orgscript check <file> --json` |
| 23 | +- Added `npm run check:all` |
| 24 | +- Integrated canonical formatting checks into CI |
| 25 | +- Unified CLI diagnostics across `validate`, `lint`, `check`, and `format --check` |
| 26 | +- Introduced stable diagnostic code namespaces for `cli`, `syntax`, `semantic`, `lint`, and `format` |
| 27 | + |
| 28 | +## Exports and visible outputs |
| 29 | + |
| 30 | +- Added `orgscript export markdown <file>` for deterministic Markdown summaries |
| 31 | +- Added Mermaid demo artifacts and generation flow |
| 32 | +- Kept Mermaid export available for `process` and `stateflow` |
| 33 | +- Extended demo material under `docs/demos` |
| 34 | + |
| 35 | +## Language maturity |
| 36 | + |
| 37 | +- Added the canonical `spec/language-spec.md` |
| 38 | +- Added governance guidance and authoring guides for humans and AI |
| 39 | +- Expanded the diagnostics contract in `spec/diagnostics.md` |
| 40 | +- Kept CI and golden snapshots green on the combined quality path |
| 41 | + |
| 42 | +## Editor support |
| 43 | + |
| 44 | +- Upgraded the VS Code OrgScript extension from a scaffold to a usable first TextMate-based syntax-highlighting integration |
| 45 | +- Registered `.orgs` files as `OrgScript` |
| 46 | +- Highlighted top-level blocks, statements, section keywords, strings, booleans, numbers, operators, and dotted references |
| 47 | +- Documented local testing in `editors/vscode/README.md` |
| 48 | + |
| 49 | +## Verification |
| 50 | + |
| 51 | +Verified with: |
| 52 | + |
| 53 | +- `npm test` |
| 54 | +- `npm run check:all` |
| 55 | +- `node ./bin/orgscript.js check ./examples/craft-business-lead-to-order.orgs` |
| 56 | +- `node ./bin/orgscript.js check ./examples/craft-business-lead-to-order.orgs --json` |
| 57 | +- `node ./bin/orgscript.js export markdown ./examples/order-approval.orgs` |
| 58 | +- `node ./bin/orgscript.js export mermaid ./examples/order-approval.orgs` |
| 59 | + |
| 60 | +## Project status |
| 61 | + |
| 62 | +OrgScript is not a programming language. |
| 63 | +It is a human-readable, AI-interpretable description language for business logic, processes, rules, roles, policies, events, and operational systems. |
| 64 | + |
| 65 | +v0.4.0 is the first release where OrgScript feels usable not only as a language implementation, but also as a contributor-facing tooling project. |
0 commit comments