Skip to content

v2.1.0

Choose a tag to compare

@github-actions github-actions released this 06 Aug 05:53
· 37 commits to main since this release

πŸš€ Added

  • Structurizr support, joining Mermaid/DBML/PlantUML/D2/Nomnoml/QuickDBD/GraphvizDOT as a registered emitter β€” entities render as elements inside a model { } block with a properties {} block per field, relationships as -> expressions, using # for comments to match the Structurizr playground's own default. (460d9e3, 26f79ca)
  • Pikchr support, rendering entities as boxes with a field list and relationship lines drawn between them. (1e1b6b6)
  • --case <mode> letter-cases rendered identifiers β€” preserve (default, source casing as-is), snake, screaming_snake, camel, pascal, kebab, title, lower, or upper. Only touches entity/field/enum-type names, never type labels, enum member values, or the --names both alias. (089a106)
  • --inflect <mode> pluralizes or singularizes entity/table identifiers only (never fields, never the --names both alias) β€” preserve (default), plural, or singular, applied before --case (e.g. --inflect plural --case kebab on PostTag β†’ post-tags). (947ca12)
  • -y, --yes forces non-interactive mode so every omitted flag falls back to its default instead of prompting, without needing --stdout or a CI environment to trigger it. (49b0a77)
  • --check --summary prints a structural (schema-level) diff grouped by entity (e.g. users: +column "last_login_at") instead of the raw line diff, by comparing the freshly extracted model against a gitignored snapshot written alongside the diagram on the last non---check run. Falls back to the raw line diff, with an explanatory note, when no snapshot exists yet or the drift is formatting/ordering-only. (92d315a)
  • "Generated by orm2erd" watermark on every emitter's output, using each format's own comment syntax. Note: this changes the output of every existing emitter by one line β€” the first --check run after upgrading will report drift on previously-generated files; regenerate and recommit to clear it. (82f5af4)
  • CLI errors now print a (run with --help to see all flags) hint. (5d57863)

πŸ’Š Fixed

  • --check without --out now errors instead of silently guessing a path to verify against. --check has no memory of what --out was used on the run that produced the committed file, so there was no safe default to fall back to β€” it's now a hard requirement, checked non-interactively before any prompting starts. (31e57ac)
  • Mermaid, DBML, PlantUML, and QuickDBD now quote entity/field identifiers that become syntactically unsafe after --case kebab (bare hyphen) or --case title/other space-containing modes, instead of emitting broken output β€” the exact trigger character(s) and quote style differ per format, verified empirically against each one's own grammar. (a63af11)