From be69af2a78f0d3d1166b4bcec732db7ff16539ef Mon Sep 17 00:00:00 2001 From: Simon Brown Date: Thu, 19 Sep 2024 10:56:05 +0100 Subject: [PATCH] Update docs. --- changelog.md | 2 +- structurizr-component/README.md | 6 +++++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/changelog.md b/changelog.md index 9052a7c6..1192cda7 100644 --- a/changelog.md +++ b/changelog.md @@ -15,7 +15,7 @@ - structurizr-dsl: Adds an `!elements` keyword that can be used to find a set of elements via an expression. - structurizr-dsl: Adds an `!relationship` keyword that can be used to find a single relationship by identifier (replaces `!ref` and `!extend`). - structurizr-dsl: Adds a `!relationships` keyword that can be used to find a set of relationships via an expression. -- structurizr-dsl: Adds a DSL wrapper around the `structurizr-component` component finder. +- structurizr-dsl: Adds a DSL wrapper around the `structurizr-component` component finder (`!components`). - structurizr-dsl: Adds support for local theme files to be specified via `theme` (https://github.com/structurizr/java/issues/331). - structurizr-dsl: An exception is now thrown when trying to use disallowed features in restricted mode (e.g. `!docs`, `!include `, etc). - structurizr-export: Adds support for icons to the Ilograph exporter (https://github.com/structurizr/java/issues/332). diff --git a/structurizr-component/README.md b/structurizr-component/README.md index 0e319527..b9f556ae 100644 --- a/structurizr-component/README.md +++ b/structurizr-component/README.md @@ -5,5 +5,9 @@ This library provides a facility to discover components in a Java codebase, via a combination of [Apache Commons BCEL](https://commons.apache.org/proper/commons-bcel/) and [JavaParser](https://javaparser.org), using a pluggable and customisable set of matching and filtering rules. +It is also available via the Structurizr DSL `!component` keyword. -__Unreleased, experimental, and potentially subject to change - see tests for an example.__ \ No newline at end of file +See the following tests for an example: + +- https://github.com/structurizr/java/blob/master/structurizr-component/src/test/java/com/structurizr/component/SpringPetClinicTests.java +- https://github.com/structurizr/java/blob/master/structurizr-dsl/src/test/resources/dsl/spring-petclinic/workspace.dsl \ No newline at end of file