Skip to content

CHANGELOG.md

Latest commit

 

History

History
61 lines (39 loc) · 3.63 KB

CHANGELOG.md

File metadata and controls

61 lines (39 loc) · 3.63 KB

Changelog

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

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

Unreleased

0.4.0 - 2026-04-16

Changed

  • Package traversal: BmmSchemaCollection::forEachPackage() supports one additional nesting level (4 deep), enabling schemas with deeper package hierarchies.

Added

  • openehr_lang_1.0.0 schema: added entity package with BMM_CLASS, BMM_CONTAINER_TYPE, BMM_EFFECTIVE_TYPE, BMM_MODEL_TYPE, BMM_GENERIC_CLASS, BMM_GENERIC_TYPE, BMM_PARAMETER_TYPE, BMM_TUPLE_TYPE, BMM_TYPE, BMM_SIMPLE_CLASS, BMM_SIMPLE_TYPE, BMM_UNITARY_TYPE, BMM_INDEXED_CONTAINER_TYPE, BMM_SIGNATURE, BMM_MODULE, BMM_ENTITY_METATYPE, and nested range_constrained sub-package (BMM_VALUE_SET_SPEC, BMM_ENUMERATION, BMM_ENUMERATION_INTEGER, BMM_ENUMERATION_STRING).
  • Re-rendered all output files for the updated schema.

0.3.0 - 2026-04-08

Changed

  • Effective AsciiDoc formatter: inherited members no longer show an ancestor prefix in the signature column (left). Instead, the documentation column (right) shows _Inherited from {AncestorType}_ as an italic note with a cross-reference link.
  • README: expanded introduction — explains what BMM and P_BMM are, links to the specs, describes each output format's role in the specifications site. Added "Extend it for your own use" section with examples of downstream artefacts. Added CI, PHP, license, and Docker badges.

0.2.0 - 2026-04-07

Changed

  • Error handling: commands catch \Throwable (was \UnhandledMatchError); error message shown at normal verbosity, full trace with -v. Filesystem::writeFile() throws on write failure.
  • Formatters: added declare(strict_types=1) to all formatter files; extracted shared formatParameterDocRows() to reduce duplication between AsciidocDefinition and AsciidocEffective.
  • BmmConstant::value cast to string before formatting (was failing on integer constants).

Added

  • BmmSchemaCollection::forEachPackage() — shared recursive package traversal, replacing duplicated triple-nested loops in 3 writers.
  • Caching in BmmSchemaCollection::getClass() and getClassPackageQName() for faster cross-schema lookups.
  • Path traversal protection: basename() sanitisation in BmmSchemaCollection::load().
  • Integration and unit tests for all 4 writers and both formatters (AsciidocDefinition, PlantUml). Test count: 26 → 55, assertions: 73 → 159.

0.1.0 - 2026-04-06

First release: a small command-line tool that turns openEHR BMM JSON into AsciiDoc, PlantUML, YAML, and extra JSON files for the specs site.

Added

  • CLI with asciidoc, plantuml, yaml, and split-json; point at schema names or all to process everything in the input folder.
  • Reads BMM JSON from resources/, writes generated files under output/ (output path overridable via BMM_OUTPUT_DIR).
  • Docker image on GitHub Container Registry, plus Makefile and CI for builds, checks, and releases.
  • Basic automated tests and static analysis for the PHP codebase.
  • Contributor docs and templates.

Input is BMM JSON only (not XMI/UML exchange files).