Skip to content

Commit

Permalink
feat: 🎸 various configuration options with .swiftplantuml.yml
Browse files Browse the repository at this point in the history
being able to include/exclude files (wildcards supported)
being able to include/exclude elements by name (wildcard supported)
being able to limit elements and members bases on their access level
being able to hide extensions
being able to hide member access level attribute
being able to configure styles and skin parameter
being able to include external PUML files (theming)

✅ Closes: #9, #10, #12
MarcoEidinger committed Mar 1, 2021
1 parent 8d9afb6 commit 6bb08f3
Showing 65 changed files with 3,350 additions and 303 deletions.
66 changes: 66 additions & 0 deletions Configuration/Examples/Rich/.swiftplantuml.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
files:
include:
- "Sources/SwiftPlantUMLFramework/**/*.swift"
exclude:
- "Tests/**/*.swift"
elements:
havingAccessLevel:
- public
showMembersWithAccessLevel:
- public
- internal
- private
showGenerics: true
showExtensions: false
showMemberAccessLevelAttribute: true
exclude:
- Logger
- LogLevel
hideShowCommands:
- hide empty members
skinparamCommands:
- skinparam sequenceMessageAlign center ## just an example; this will have no impact to a class diagram
includeRemoteURL: https://raw.githubusercontent.com/bschwarz/puml-themes/master/themes/hacker/puml-theme-hacker.puml
relationships:
inheritance:
label: "inherits from"
style:
lineStyle: dotted
lineColor: DarkViolet
textColor: DarkViolet
exclude:
- "Codable"
realize:
label: "confirms to"
style:
lineStyle: dashed
lineColor: Blue
textColor: Blue
dependency:
label: extends
style:
lineStyle: bold
lineColor: DarkGreen
textColor: DarkViolet
stereotypes:
class:
name: class
spot:
character: C
color: AliceBlue
struct:
spot:
character: S
color: AntiqueWhite
extension:
spot:
character: X
color: AntiqueWhite
enum:
spot:
character: E
color: AntiqueWhite
protocol:
spot:
character: P
color: AntiqueWhite
14 changes: 14 additions & 0 deletions Configuration/Examples/SkinParam/.swiftplantuml.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
files:
exclude:
- "Tests/**/*.swift"
elements:
havingAccessLevel:
- public
showMembersWithAccessLevel:
- public
skinparamCommands:
- skinparam classBackgroundColor PaleGreen
- skinparam classArrowColor SeaGreen
- skinparam classBorderColor SpringGreen
- skinparam stereotypeCBackgroundColor YellowGreen
- skinparam stereotypeCBackgroundColor<< Foo >> DimGray
Loading

0 comments on commit 6bb08f3

Please sign in to comment.