Skip to content

v0.9.1 - safe comments, structured annotations, and annotation-aware exports

Choose a tag to compare

@DKFuH DKFuH released this 30 Mar 06:41
· 35 commits to main since this release

OrgScript v0.9.1

OrgScript v0.9.1 is a stabilization release focused on safe metadata, clearer downstream exports, and cleaner onboarding material.

This release builds directly on the v0.9.0-rc1 distribution candidate and turns that state into a cleaner, more trustworthy package for real-world use.

Highlights

  • safe whole-line comments with explicit non-authoritative semantics
  • allowlisted structured annotations in the AST and canonical model
  • optional annotation rendering in Markdown and HTML exports
  • explicit annotation metadata in export context
  • stronger VS Code support with snippets and improved language configuration
  • refreshed English and German manuals plus removal of legacy .docx artifacts

Language safety

  • added whole-line # ... comments for human-only notes
  • added allowlisted annotations via @key "value"
  • kept comments out of canonical export, analysis, and machine-facing interpretation
  • kept annotations non-semantic and metadata-only
  • added lint protection for suspicious comments that look like hidden business rules

Export and AI/tooling improvements

  • orgscript export markdown <file> --with-annotations can now render allowlisted annotations in generated summaries
  • orgscript export html <file> --with-annotations can now render allowlisted annotations in generated HTML documentation
  • orgscript export context <file> now exposes annotation metadata explicitly under source.metadata.annotations
  • comments remain excluded from machine-facing exports by default

Editor and onboarding improvements

  • added VS Code snippets for comments, annotations, and core OrgScript blocks
  • improved VS Code language configuration with safer indentation hints
  • rewrote the English and German handbooks on the current language/tooling surface
  • removed obsolete .docx handbook artifacts from the repository

Verification

Confirmed on the release preparation state:

  • npm test
  • npm run check:all
  • node ./bin/orgscript.js validate ./examples/lead-qualification.orgs
  • node ./bin/orgscript.js check ./examples/craft-business-lead-to-order.orgs
  • node ./bin/orgscript.js check ./examples/craft-business-lead-to-order.orgs --json
  • node ./bin/orgscript.js export markdown ./examples/lead-qualification.orgs --with-annotations
  • node ./bin/orgscript.js export html ./examples/lead-qualification.orgs --with-annotations
  • node ./bin/orgscript.js export context ./examples/lead-qualification.orgs
  • node ./bin/orgscript.js export json ./examples/lead-qualification.orgs
  • node ./bin/orgscript.js analyze ./examples/lead-qualification.orgs --json

Project status

OrgScript remains a human-readable, AI-friendly description language for business logic, processes, rules, roles, policies, events, metrics, and operational systems.

v0.9.1 focuses on trust: keeping comments safe, metadata explicit, exports deterministic, and the project easier to adopt.