Skip to content

CHANGELOG.md

Latest commit

 

History

History
141 lines (110 loc) · 9.11 KB

CHANGELOG.md

File metadata and controls

141 lines (110 loc) · 9.11 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project follows Semantic Versioning.

[Unreleased]

[0.9.6] - 2026-04-03

  • Improved the LittleHorse exporter with a real workflow constructor scaffold and kebab-case workflow names.
  • Added real-code mode (--littlehorse-real) that emits stub-only output without comment-only lines.
  • Mapped if / else if / else to explicit LittleHorse chaining and added variable declaration stubs.
  • Polished VS Code TextMate scopes for operators and dotted references, plus added local testing guidance.
  • Expanded exporter trust guidance in the AI guide and tightened CLI help notes.

[0.9.5] - 2026-04-01

  • Added new export targets: BPMN skeleton, PlantUML skeleton, LittleHorse scaffold, Graph JSON, and Contract JSON.
  • Clarified exporter trust and maturity across README, manuals, and AI guidance.
  • Added exporter maturity matrix and trust-level notes to steer tooling expectations.
  • Documented security posture in SECURITY.md and summarized it in the README.
  • Tightened CLI help to point at exporter maturity without overloading the interface.

[0.9.4] - 2026-03-31

  • Added an optional document language metadata header with orgscript 1 plus source-language, comment-language, annotation-language, and context-language.
  • Treated declared language metadata as a stricter document contract while keeping the OrgScript core syntax canonical in English.
  • Added canonical JSON and context-export support for document metadata.
  • Added conservative lint checks for obvious comment and annotation language mismatches.
  • Updated the formatter, VS Code grammar/snippets, specs, examples, manuals, and tests for the new header.

[0.9.3] - 2026-03-30

  • Renamed the npm package to @dkfuh/orgscript after npm rejected the unscoped orgscript name as too similar to an existing package.
  • Updated installation guidance to use npm install -g @dkfuh/orgscript while keeping the CLI command name orgscript.
  • Re-verified package and publish readiness for the scoped public npm path.

[0.9.2] - 2026-03-30

  • Normalized npm publish metadata so bin.orgscript and repository.url no longer require npm auto-correction during publish.
  • Kept NOTICE in the published package and tightened package keywords for npm/package discovery.
  • Confirmed publish readiness through npm publish --dry-run and local global-install verification from the packaged tarball.

[0.9.1] - 2026-03-30

  • Added safe whole-line # comments for human-readable notes on supported blocks and statement lines.
  • Added allowlisted structured annotations via @key "value" with AST and canonical-model support.
  • Added lint protection for suspicious business-logic-like comments to keep comments non-authoritative.
  • Updated the formatter, diagnostics, specs, editor grammar, and tests for comments and annotations.
  • Added optional annotation rendering for Markdown and HTML export via --with-annotations.
  • Added an explicit annotation metadata block to export context for AI and tooling consumers.
  • Added VS Code snippets plus small language-configuration improvements for comments and annotations.
  • Rewrote the DE/EN handbooks on the current language and tooling surface and removed legacy .docx artifacts.

[0.9.0-rc1] - 2026-03-29

  • Prepared OrgScript for public distribution as a release candidate with npm/package metadata aligned to 0.9.0-rc1.
  • Added src/index.js as a cleaner package entry point for library-style consumption.
  • Hardened repository metadata for GitHub, npm, and marketplace-facing usage.
  • Prepared the VS Code extension package for external distribution and aligned its metadata with the release candidate.
  • Added and polished GitHub Pages-style documentation site artifacts and publishing workflow support.
  • Added DE/EN handbook-style manuals and completed missing Mermaid demo artifacts in the showcase flow.

[0.8.0] - 2026-03-29

  • Introduced orgscript analyze <file> for deterministic structural analysis (block counts, metrics, and complexity hints).
  • Added orgscript export context <file> to package logic for AI-ready workflows (Bundled model, analysis, and summaries).
  • Published integration recipes for GitHub Actions and pre-commit hooks under docs/integrations/.
  • Upgraded documentation site builder to highlight the "Source-to-Docs" flow and unified artifacts.
  • Expanded the showcase with a high-quality "Incident Escalation" trust case.
  • Stabilized CLI output for analysis and context exports.

[0.7.0] - 2026-03-29

  • Enhanced CLI for professional distribution: added --version and improved help text.
  • Enabled global installation support via npm install -g orgscript.
  • Prepared VS Code extension for marketplace: fixed manifest warnings and updated metadata.
  • Automated a documentation site via scripts/build-docs.js for GitHub Pages.
  • Added a comprehensive "Hiring Process" hero example to demonstrate advanced process modeling.
  • Stabilized the repository structure and baseline artifacts for public adoption.

[0.6.0] - 2026-03-29

  • Added first HTML documentation exporter via orgscript export html <file>.
  • Refined Mermaid export with improved styling, parallelogram shapes for triggers, and semantic markers for state diagrams.
  • Upgraded Markdown summary export (v2) with Table of Contents (TOC), inter-block separators, and better header hierarchy.
  • Reorganized and expanded the demo suite under docs/demos/ to include HTML, Markdown, and Mermaid artifacts for all hero examples.
  • Stabilized the canonical JSON model (v0.2) and updated its specification in spec/canonical-model.md.
  • Improved business-level phrasing in all summary exporters for better stakeholder readability.
  • Consolidated "Artiflow Flow" in documentation to show the path from .orgs to visual/structured outputs.

[0.5.0] - 2026-03-29

  • Refined VS Code TextMate grammar to support inline keywords and dotted properties correctly.
  • Improved VS Code extension onboarding and local testing documentation.
  • Revamped README.md with a 60-second quickstart and a visual "Three-Value Flow" showcase.
  • Curated the example catalog into Simple, Realistic, and Advanced categories with clearer descriptions.
  • Polished CLI diagnostics UX with bracketed codes, padded severities, and "passed" status messaging.
  • Added docs/language-evolution.md for clear governance on language vs. tooling growth.
  • Updated the diagnostics text contract in spec/diagnostics.md to match reality.

[0.4.0] - 2026-03-29

  • Added orgscript format <file> --check for canonical formatting checks without rewriting files.
  • Added npm run format:check:all and integrated formatting checks into CI.
  • Added orgscript check <file> as the combined quality command for validation, linting, and formatting checks.
  • Added orgscript check <file> --json for machine-readable combined quality diagnostics.
  • Added npm run check:all and switched CI to the combined quality path.
  • Added orgscript export markdown <file> for concise Markdown summaries of OrgScript files.
  • Added Markdown summary golden snapshots and demo outputs.
  • Added orgscript export mermaid <file> for first-pass Mermaid exports of processes and stateflows.
  • Added npm run demo:generate plus a Mermaid demo package with generated Markdown and .mmd artifacts.
  • Added a canonical master language spec and lightweight governance guidance.
  • Added an example catalog and an initial VS Code syntax-highlighting scaffold.
  • Unified CLI diagnostics across validate, lint, check, and format --check.
  • Added stable diagnostic code namespaces for syntax, semantic validation, lint, format, and CLI usage errors.
  • Added format --check --json and documented JSON diagnostics with real examples.
  • Upgraded the VS Code OrgScript extension from a scaffold to a usable first TextMate-based syntax-highlighting integration.

[0.3.0] - 2026-03-29

  • Added the first AST-backed formatter via orgscript format <file>.
  • Added formatter stability tests to ensure canonical example files remain idempotent.
  • Added the first AST-backed linter via orgscript lint <file>.
  • Added lint fixtures for process triggers, unreachable statements, orphan states, and conflicting role permissions.
  • Formalized lint severities as error, warning, and info.
  • Stabilized lint output with deterministic ordering and a severity summary line.
  • Added machine-readable diagnostics for validate --json and lint --json.
  • Made lint exit codes CI-friendly by failing only when findings contain error.
  • Added GitHub Actions CI for tests, example validation, and example linting.
  • Added human and AI usage guides plus a documented diagnostics contract.

[0.2.0] - 2026-03-29

  • Established the OrgScript project foundation, manifesto, syntax, semantics, and canonical model drafts.
  • Added a working CLI with validate and export json.
  • Implemented a lexer, parser, AST layer, semantic validation, and canonical JSON export.
  • Added realistic example files and a fully English hero example.
  • Added golden snapshot tests for AST and canonical model output, plus invalid fixtures.
  • Switched the project license to Apache-2.0 and added a NOTICE file.