Example

scala2plantuml \  --url'https://repo1.maven.org/maven2/nz/co/bottech/scala2plantuml-example_2.13/0.3.0/scala2plantuml-example_2.13-0.3.0.jar'\  --project example \"nz/co/bottech/scala2plantuml/example/Main."

@startumlclass A extends B {  + {method} <init>  + {method} b}A o-- Cinterface B {  + {abstract} {method} b}B o-- Cclass C {  + {method} <init>  + {field} value}C o-- Aclass Main {  + {static} {field} a}Main o-- A@enduml

sbt

Enable SemanticDB

semanticdbEnabled:=true

addCompilerPlugin("org.scalameta"%"semanticdb-scalac"%"x.y.z" crossCrossVersion.full)scalacOptions+="-Yrangepos"

Add Scala2PlantUMLPlugin

addSbtPlugin("nz.co.bottech" % "sbt-scala2plantuml" % "0.3.0")

Generate the Diagram

scala2PlantUML"com/example/Foo#"

CLI

Install

cs install --channel https://git.io/Jqv1i scala2plantuml

Usage

scala2plantuml --help

Scala2PlantUML version 0.3.0Usage: scala2plantuml [options] symbolScala2PlantUML generates PlantUML Class Diagrams from Scala SemanticDB files.  symbol                   The symbol to use as the starting point for generating the diagram.                                                      To get a symbol from a class name, convert the package name separate '.' to '/' and add a '#'                           suffix. For an object use a suffix of '.'.                                                      See https://scalameta.org/docs/semanticdb/specification.html#symbol-1 for the full syntax.                                                      Examples:                             'com/example/Foo#' (class com.example.Foo)                             'com/example/Foo.' (object com.example.Foo)                             'com/example/Foo.bar.' (value/variable bar on object com.example.Foo)                             'com/example/Foo#baz().' (function baz on class com.example.Foo)The --include and --exclude options control which symbols will be processed. Each of these can be provided multiple times.The pattern supports two wildcards:1) ** (matches any character)2) *  (matches all characters except for '/')  -i, --include <pattern>  Only include symbols that match the pattern.                                                      Default: '**'                                                      Example:                             --include 'com/example/**/model/*'  -e, --exclude <pattern>  Excludes all symbols that match the pattern.                                                      Default: 'scala/**', 'java/**'                                                      Example:                             --exclude 'com/example/**/data/*'The --dir, --jar, and --url options specify the directories and JAR files that are used when locating SemanticDB files.Each of these can be provided multiple times.By default, the classpath that was used when executing Scala2PlantUML is also used.  -d, --dir <dir>          Directories of the SemanticDB target roots containing META-INF/semanticdb/**/*.semanticdb files.                                                      Example:                             --dir 'my-project/target/scala-2.13/meta'  -j, --jar <jar>          JAR containing META-INF/semanticdb/**/*.semanticdb files.                                                      Example:                             --jar 'foo.jar'  -u, --url <url>          A URL to a JAR containing META-INF/semanticdb/**/*.semanticdb files.                                                      Example:                             --url 'https://repo1.maven.org/maven2/com/example/foo/foo_2.13/1.0.0/foo_2.13-1.0.0-semanticdb.jar'The --project and --source options specify where within the search locations the SemanticDB files can be found.Each of these can be provided multiple times. The result will be all combinations of projects and source roots.  -p, --project <project>  The name of the projects that have SemanticDB files.                                                      The project name will be used when looking for SemanticDB files such as:                           META-INF/semanticdb/<project>/<source>/*.semanticdb                                                      An empty project name will search in:                           META-INF/semanticdb/<source>/*.semanticdb                                                      Default: ''                                                      Example:                             --project my-project  -s, --source <source>    The directory relative to the project where the source files were located.                                                      The source will be used when looking for SemanticDB files such as                           META-INF/semanticdb/<project>/<source>/*.semanticdb.                                                      Default: src/main/scala                                                      Example:                             --source 'source/scala'  -l, --max-level <level>  The maximum number of levels that will be traversed when following symbol references.                                                      This means that parent symbols that would be beyond the max level will not be shown.                                                      A diagram with a max-level of 1 will only contain the initial symbol.                                                      Default: Unlimited                                                      Example:                             --max-level 3  -o, --output <file>      Write the output to the given file.                                                      Example:                             --output docs/diagrams/my-project.puml  -c, --colour <value>     Enables coloured output.                                                      Default: true                                                      Example:                             --colour false  -v, --verbose            Increases the log level.                                                      This can be provided twice for the most verbose logging.                                                      Example:                             -vv  -h, --help  --version

Library

Limitations