|
1 | 1 | # OrgScript v0.5.0 |
2 | 2 |
|
3 | | -OrgScript v0.5.0 is the first adoption and polish release. |
| 3 | +OrgScript v0.5.0 is a developer-experience, adoption, and polish release. |
4 | 4 |
|
5 | | -This release focuses on making OrgScript as easy as possible to try, read, and understand. Instead of expanding the language, we improved the developer experience at the "front door"—our README, examples, diagnostics, and editor highlighting. |
| 5 | +This release does not expand the language itself. Instead, it improves how OrgScript is read, tried, understood, and used in practice. |
6 | 6 |
|
7 | 7 | ## Highlights |
8 | 8 |
|
9 | | -- **Visual Showcase**: A revamped `README.md` showing the "Three-Value Flow" from `.orgs` source to visual artifacts. |
10 | | -- **60-Second Quickstart**: Faster path from installation to first successful command. |
11 | | -- **Improved Highlighting**: Refined TextMate grammar for VS Code, including inline keywords and dotted properties. |
12 | | -- **Curated Examples**: Reorganized example catalog categorized by learning depth (Simple, Realistic, Advanced). |
13 | | -- **Polished Diagnostics**: More readable CLI reports with consistent padding, bracketed codes, and "passed" status messaging. |
14 | | -- **Language Evolution Governance**: Documented boundaries between core language growth and tooling-level extensions. |
| 9 | +### Better front door and onboarding |
| 10 | +- The README now presents the core value of OrgScript more clearly |
| 11 | +- Added a stronger quickstart path |
| 12 | +- The “three-value flow” is now visible near the top: |
| 13 | + - OrgScript source |
| 14 | + - Mermaid diagram |
| 15 | + - Markdown summary |
15 | 16 |
|
16 | | -## CLI and UX |
| 17 | +### Improved VS Code highlighting |
| 18 | +- Refined the initial VS Code syntax grammar |
| 19 | +- Better handling for inline keywords and dotted references |
| 20 | +- Improved local editor onboarding documentation |
17 | 21 |
|
18 | | -- Updated `check`, `lint`, and `format --check` to use `passed` instead of `ok` in human-readable output. |
19 | | -- Refined diagnostic line formatting: ` SEVERITY [code] file:line - message`. |
20 | | -- Added consistent padding to severity levels for better vertical alignment in logs. |
21 | | -- Synchronized the diagnostics text contract in `spec/diagnostics.md` with the new CLI behavior. |
| 22 | +### Curated example catalog |
| 23 | +- The example catalog is now structured into: |
| 24 | + - simple |
| 25 | + - realistic |
| 26 | + - advanced |
| 27 | +- Each example is easier to understand as a learning and adoption asset |
22 | 28 |
|
23 | | -## Documentation and Onboarding |
| 29 | +### Diagnostics UX polish |
| 30 | +- CLI text output is now more consistent and deliberate |
| 31 | +- `ok` is now reported as `passed` |
| 32 | +- Diagnostic codes are shown more clearly in bracketed form |
| 33 | +- Output spacing and readability were improved without changing the documented JSON contract |
24 | 34 |
|
25 | | -- Added a visual showcase in the root `README.md`. |
26 | | -- Added categorized example descriptions in `examples/README.md`. |
27 | | -- Added `docs/language-evolution.md` for clear project governance. |
28 | | -- Improved VS Code extension onboarding and local testing documentation. |
| 35 | +### Language evolution guidance |
| 36 | +- Added `docs/language-evolution.md` |
| 37 | +- Clarifies what belongs to core language evolution vs tooling, exporters, and editor integrations |
| 38 | +- Establishes a cleaner baseline for future breaking-change discussions |
29 | 39 |
|
30 | | -## Editor Support |
| 40 | +## Scope note |
31 | 41 |
|
32 | | -- Refined `editors/vscode/syntaxes/orgscript.tmLanguage.json` to handle keywords like `then` and `else if` without requiring line-start positioning. |
33 | | -- Improved coloring for dotted references and operators. |
34 | | -- Cleaned up scope naming for better compatibility with modern VS Code themes. |
| 42 | +v0.5.0 intentionally focuses on usability and adoption. |
| 43 | + |
| 44 | +It does **not** introduce: |
| 45 | +- new language keywords |
| 46 | +- new block types |
| 47 | +- parser redesigns |
| 48 | +- IntelliSense / hovers / semantic tokens |
| 49 | +- speculative future syntax |
35 | 50 |
|
36 | 51 | ## Verification |
37 | 52 |
|
38 | | -Verified with: |
| 53 | +Verified on the current release state with: |
39 | 54 |
|
40 | 55 | - `npm test` |
41 | 56 | - `npm run check:all` |
42 | 57 | - `node ./bin/orgscript.js check ./examples/craft-business-lead-to-order.orgs` |
43 | 58 | - `node ./bin/orgscript.js export mermaid ./examples/order-approval.orgs` |
44 | 59 | - `node ./bin/orgscript.js export markdown ./examples/order-approval.orgs` |
45 | 60 |
|
46 | | -## Project Status |
| 61 | +## Project direction |
| 62 | + |
| 63 | +OrgScript is becoming easier to try, easier to demo, and easier to trust. |
47 | 64 |
|
48 | | -v0.5.0 ensures that OrgScript is not just a stable specification, but a toolset that invites exploration. By focusing on polish and adoption readiness, we have made the project's value proposition visible at first glance. |
| 65 | +The next release cycle will focus on integrations, generated artifacts, and stronger showcase value. |
0 commit comments