All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
- Diagrams no longer default to confidential
table_column
will default to'VARCHAR'
data type if unspecified
JunctionTable
element for quickly making a junction table between two tables
- Renamed
$poly_id_suffix
to$fk_suffix
argument inSET_SCHEMA_DEFAULTS
- Setting the diagram type when calling
Enrich
is no longer case sensitive
- Missing revision name in title block
PartialTable
element type for quickly defining a Table with omitted columns and a PKTableLayer
element for grouping tables together- Control which timestamp table columns are added when calling
table_timestamps()
- Support for "destroyed_at" timestamp table column
- Setting and presenting table column nullability as a data type
$setup_std_diagram
renamed toEnrich
- Define diagram info via names arguments to
Enrich
instead of global variables PK_TYPE
replaced by callingSET_SCHEMA_DEFAULTS
with named argument$id_type
table
element renamed toTable
(case-sensitive)enum_mapping
element renamed toEnumType
(case-sensitive)poly_assoc
merged intohas_one_poly
timestamps
renamed totable_timestamps
omitted_columns
renamed totable_omission
column_fk_poly
renamed totable_poly_fk
- Omitted columns on tables is more clear
- Table foreign keys and polymorphic columns are non-nullable by default
- Use
enum_value('enum name', 'enum value')
when definingenum
objects - Ability to model polymorphic relationships in ER diagrams
- ER diagrams to use orth/straight lines by default
- Improvements to container shape styles
- Improvements to ER table field styling
- Hide the merge diamond on conditional flows in activity diagrams by default
- Support for Deployment diagrams via new diagram type "deployment"
- Support for Object diagrams via new diagram type "object"
- Support for Use Case diagrams via new diagram type "usecase"
- Ability to retheme diagrams by overwriting
$theme_data
json data
- Renamed
$setup_std_diagram_for
to$setup_std_diagram
- No longer need to set a diagram type when bootstrapping generic diagrams
- Improvements to footer styling when company information is missing
- Setting
$title
is no longer required
- Easier way to bootstrap your diagram via
$setup_std_diagram_for("<diagram-type>")
- Must define diagram type when applying styles
$use_horizontal_layout()
layout helper- Styling for all builtin PlantUML shapes and objects
- Ability to mark diagrams as non-confidential (confidential by default)
- Support for setting a diagram revision number (via
$revision_name
) - Toggle to hide diagram title, headers, and footer when using
$setup_std_diagram_for
- Requires PlantUML v2021 and higher
USE_WORD_WRAP()
now called$use_word_wrap()
USE_DEFAULT_STYLES()
replaced by$apply_std_style()
USE_ERD_STYLES()
replaced by calling$setup_std_diagram_for("er")
header STD_HEADER
replaced by$setup_std_diagram_for
footer STD_FOOTER
replaced by$setup_std_diagram_for
- No need to call
title
when using$setup_std_diagram_for
with$title
set TODAY
replaced by$today
COMPANY_NAME
replaced by$company_name
AUTHOR_NAME
replaced by$author_name
- Refined styling for consistency across all diagram types
- Sequence diagrams will default to
autoactivate on
andautonumber
- Actors will use non-stick variant (except in sequence diagrams)
- State shapes to use compact shape if they have no description text
- First release of Enriched!
- This CHANGELOG file to hopefully serve as an evolving example of a standardized open source project CHANGELOG.
- README now contains how to setup and use Enriched