I get the message:
Traceback (most recent call last):
brew extract or brew create and brew tap-new to create a formula file in a tap on GitHub instead.: Invalid usage: Non-checksummed download of swiftplantuml formula file from an arbitrary URL is unsupported! (UsageError)

Elements (classes, structs, ...) or members (properties and functions) with access level open will currently not be parsed and converted into PlantUML script.

Throughout the source and generated diagrams, the relationship between a protocol and a type that conforms to the protocol is written as “confirms to”. This is a typo.

Excerpt from https://docs.swift.org/swift-book/LanguageGuide/Protocols.html:

Any type that satisfies the requirements of a protocol is said to conform to that protocol.

In the .swiftplantuml.yml configuration file it would be helpful to add one or more of the following command commands:

• header
• title
• legend
• caption
• footer

Example visualization

Example PlantUML script

@startuml
header
<u>Simple</u> header example
on <i>several</i> lines and using <font color=red>html</font>
end header

title
<u>Simple</u> title example
on <i>several</i> lines and using <font color=red>html</font>
end title

caption
<u>Simple</u> caption example
on <i>several</i> lines and using <font color=red>html</font>
end caption

footer
<u>Simple</u> footer example
on <i>several</i> lines and using <font color=red>html</font>
end footer

legend
<u>Simple</u> legend example
on <i>several</i> lines and using <font color=red>html</font>
end legend

class Class1 {}
class Class2 {}

Class1 -- Class2
@enduml

Members do not show an access level indicator if they have fileprivate access level

class aClass {
    var computedProperty: String {}
    func aFunction() {}
}

fileprivate extension aClass {
    var extComputedProperty: String { "" }
    func extFunction()
}

Current (unexpected) output

@startuml
' STYLE START
hide empty members
skinparam shadowing false
' STYLE END


class "aClass" as aClass << (C, DarkSeaGreen) >> { 
  ~computedProperty : String
  ~aFunction() 
}
class "aClass" as aClass0 << (X, Orchid) extension >> { 
  extComputedProperty : String
  extFunction() 
}

aClass <.. aClass0 : ext
@enduml

Expected output

@startuml
' STYLE START
hide empty members
skinparam shadowing false
' STYLE END


class "aClass" as aClass << (C, DarkSeaGreen) >> { 
  ~computedProperty : String
  ~aFunction() 
}
class "aClass" as aClass0 << (X, Orchid) extension >> { 
  -extComputedProperty : String
  -extFunction() 
}

aClass <.. aClass0 : ext
@enduml

Hello~
Thank you for awesome tools and saving a ton of times.

How to exclude Foundation.kit classes and SPM classes?
I can't find the option.

In version 0.2.1 and lower

unknown type for variables declared with type inference (e.g. var count = 0) => this is a limitation of SourceKitten :(

Apparently SourceKitten is able to provide the information but macosx SDK is needed (~ Xcode)

`swiftplantuml ./Compass\ App/` --output consoleOnly

Illegal instruction: 4

Although I'd had loved to install the tool, it is not possible; neither as app, nor via homebrew.

Environment:
MacOS 11.1
Xcode Version 12.3 (12C33)

When installing as App according to the instructions (download, unzip, move to programs, start), no entry for Xcode appears in system settings.

When installing with brew, this message is displayed:

brew install https://raw.githubusercontent.com/MarcoEidinger/SwiftPlantUML/main/swiftplantuml.rb
Traceback (most recent call last):
brew extract or brew create and brew tap-new to create a formula file in a tap on GitHub instead.: Invalid usage: Non-checksummed download of swiftplantuml formula file from an arbitrary URL is unsupported! (UsageError)
brew extract or brew create and brew tap-new to create a formula file in a tap on GitHub instead.: Invalid usage: Non-checksummed download of swiftplantuml formula file from an arbitrary URL is unsupported! (UsageError)

Any way to get around this?

Hi,

First of all, I would like to thank you, this is a great project and it will help a lot to clarify our architecture and document it.

I've faced with the following syntax error: link

Code snippet to reproduce:

class A<U> {}

final class B<U>: A<U> {}

Enumerations are often created to support a specific class or structure’s functionality. Similarly, it can be convenient to define utility classes and structures purely for use within the context of a more complex type. To accomplish this, Swift enables you to define nested types, whereby you nest supporting enumerations, classes, and structures within the definition of the type they support.

To nest a type within another type, write its definition within the outer braces of the type it supports. Types can be nested to as many levels as are required.

Nested Types do not get rendered by SwiftPlantUML

Ideally, there would be an option to render them.

Example Input

public struct OuterOuter {
    public struct Outer {
        public enum Inner {}
    }
}

Possible Output

Sorry to bother with a question not directly related to the project, but how do you get the percentage on your documentation badge (at the README.md)? is it generated by jazzy? is it a real calculated value or is it hardcoded? I could not find where it was calculated.

Description

Converting a protocol code that inherits multiple protocols separated by '&' into PlantUML text results in a syntax error.
This does not occur when they are separated by ','.

Steps to Reproduce

Separated by "&"

input

public protocol ResponseSerializer<SerializedObject>: DataResponseSerializerProtocol & DownloadResponseSerializerProtocol { }

output

DataResponseSerializerProtocol & DownloadResponseSerializerProtocol <|.. ResponseSerializer : inherits

-> Error occurred

Separated by ","

input

public protocol ResponseSerializer<SerializedObject>: DataResponseSerializerProtocol, DownloadResponseSerializerProtocol { }

output

DataResponseSerializerProtocol <|.. ResponseSerializer : conforms to
DownloadResponseSerializerProtocol <|.. ResponseSerializer : conforms to

It seems that it should be modified to work the same as when separated by ',' even when separated by '&' 🤔

Hi!

First of all, I want to thank you for your work, I really love ❤️ this project, I've been waiting for a tool like this (sourcery+plantuml) for quite a long time!

Next, I've found a problem that I don't if it's a bug or I'm missing something.

I've two files:

Container.swift
public struct Container: Codable {

    public var url: String
    public var headers: ContainerHeaders?

    public init(url: String, headers: ContainerHeaders? = nil) {
        self.url = url

        self.headers = headers
    }

    public enum CodingKeys: String, CodingKey {
        case url
        case headers
    }
}

ContainerHeaders.swift
public struct ContainerHeaders: Codable {

    public var name: String
    public var value: String

    public init(name: String, value: String) {
        self.name = name
        self.value = value
    }
}

With those, I try to generate a diagram using this command

swiftplantuml classdiagram  Container.swift ContainerHeaders.swift --sdk $(xcrun --show-sdk-path -sdk macosx) --output consoleOnly

Which results in an error, as it can bee seen in the output given:

@startuml
' STYLE START
hide empty members
skinparam shadowing false
' STYLE END


class "Container" as Container << (S, SkyBlue) struct >> {
  +url : String
  +headers : <<error type>>
  +init(url:headers:)
}
class "ContainerHeaders" as ContainerHeaders << (S, SkyBlue) struct >> {
  +name : String
  +value : String
  +init(name:value:)
}
Container --|> Codable : inherits
ContainerHeaders --|> Codable : inherits

@enduml

So, is this a bug or do I miss something?

I have files structured in this way:

❯ tree -a
.
├── .DS_Store
├── .swiftplantuml.yml
├── also_ok
│   └── swift.swift
├── ok
│   └── swift.swift
└── unwanted
    └── swift.swift

4 directories, 5 files

Each swif.swift file contains one protocol named after the directory.

Configuration file contains:

files:
  include:
  - ok
  - also_ok
  exclude:
  - unwanted

Then swiftplantuml . --verbose output is as follows:

14:03:28.543 💙 INFO ConfigurationProvider.readSwiftConfig():28 - search for config file in current directory with name '.swiftplantuml.yml'
14:03:28.546 💙 INFO ConfigurationProvider.readSwiftConfig():30 - .swiftplantuml.yml file found
14:03:28.546 💙 INFO ClassDiagram.run():65 - SDK: no SDK path provided
14:03:28.546 💙 INFO FileCollector.getFiles():24 - paths will be ignored in favor of configuration (files:include: also_ok, ok)
14:03:28.636 💚 DEBUG SyntaxStructureProvider.create():31 - read file:///{redacted}/unwanted/swift.swift  in 0.08880603313446045
14:03:28.636 💚 DEBUG SyntaxStructureProvider.create():31 - read file:///{redacted}/also_ok/swift.swift  in 0.0003809928894042969
14:03:28.637 💚 DEBUG SyntaxStructureProvider.create():31 - read file:///{redacted}/ok/swift.swift  in 0.0004260540008544922
14:03:28.637 💚 DEBUG PlantUMLScript.init():60 - PlantUML script created in 1.5974044799804688e-05 seconds
14:03:28.637 💙 INFO ClassDiagramGenerator.logProcessingDuration():61 - Class diagram generated in 0.08993899822235107 seconds and will be presented now

It seems like the exclude option is either not printed or totally ignored here:
14:03:28.546 💙 INFO FileCollector.getFiles():24 - paths will be ignored in favor of configuration (files:include: also_ok, ok)
and even though include option is specified it still creates diagram for types found in unwanted directory:
14:03:28.636 💚 DEBUG SyntaxStructureProvider.create():31 - read file:///{redacted}/unwanted/swift.swift in 0.08880603313446045

The same behaviour is for: swiftplantuml . --verbose --exclude unwanted, without configuration file:

14:23:28.450 💙 INFO ConfigurationProvider.readSwiftConfig():28 - search for config file in current directory with name '.swiftplantuml.yml'
14:23:28.456 💙 INFO ConfigurationProvider.decodeYml():49 - cannot find/read yaml file
14:23:28.456 💙 INFO ConfigurationProvider.readSwiftConfig():33 - return default configuration
14:23:28.456 💙 INFO ClassDiagram.run():65 - SDK: no SDK path provided
14:23:28.551 💚 DEBUG SyntaxStructureProvider.create():31 - read file:///{redacted}/unwanted/swift.swift  in 0.09683799743652344
14:23:28.552 💚 DEBUG SyntaxStructureProvider.create():31 - read file:///{redacted}/also_ok/swift.swift  in 0.0007170438766479492
14:23:28.553 💚 DEBUG SyntaxStructureProvider.create():31 - read file:///{redacted}/ok/swift.swift  in 0.0006769895553588867
14:23:28.553 💚 DEBUG PlantUMLScript.init():60 - PlantUML script created in 7.009506225585938e-05 seconds
14:23:28.553 💙 INFO ClassDiagramGenerator.logProcessingDuration():61 - Class diagram generated in 0.09848403930664062 seconds and will be presented now

In both cases, the graph is as follows:

@startuml
' STYLE START
hide empty members
skinparam shadowing false
' STYLE END
set namespaceSeparator none


class "Unwanted" as Unwanted << (P, GoldenRod) protocol >> {  
}
class "AlsoOk" as AlsoOk << (P, GoldenRod) protocol >> {  
}
class "Ok" as Ok << (P, GoldenRod) protocol >> {  
}


@enduml

The expected output would be to not read files from unwanted directory (regardless if it's specified in excluded or not), thus types defined there won't end up in the diagram.

Is there a option that draws 'Composition' as uml?

pwee$ swiftplantuml
Fatal error: Loading sourcekitd.framework/Versions/A/sourcekitd failed: file SourceKittenFramework/library_wrapper.swift, line 31
Illegal instruction: 4

Got the above error when running in a directory with swift files

top to bottom direction
left to right direction

when the diagram is too wider, left to right direction may help out. Can we set left to right?
https://plantuml.com/use-case-diagram#d551e48d272b2b07

Update

test with this setting, it works

skinparamCommands: # see https://plantuml.com/skinparam
     - left to right direction

its throws an error saying :Could not read contents of...
this is the command line i entered : swiftplantuml classdiagram Views Model Controllers

Hi Marco,

When I try to install the tool I receive a mismatch on the SHA56 code.

Can you help me?

Tks

I'm able to run brew install swiftplantuml but when I try to use it I get the following error:
-bash: swiftplantuml: command not found

MacOS 12.1

If subclasses and/or extensions are scanned before their parent class then the class diagram gets generated incorrectly.

Example

internal class aSublcass: aClass {}

internal extension aClass {
    var extComputedProperty: String { "" }
    private func extFunction() {}
}

class aClass {
    var computedProperty: String { "" }
    func aFunction() {}
}

internal extension aClass {
    private func extFunction2()
}

Current (unexpected) output

Expected output

Related: MarcoEidinger/SwiftPlantUML-Xcode-Extension#26

Example

public enum APublic {
    public enum BPublic {
        public static func publicFuncDefinedInType() {}
    }
}

// Extension is declared public, so each top level member "inherits" that access level.
public extension APublic.BPublic {
    
    // Hence this is public even if it is not annotated
    static func hasAccessLevel() -> String { return "public" }
    
    // Also this class is public
    class CPublic { // NEW: nested type defined in extension
        // However, its members must be annotated. This is public
        public static func publicFunc() {}
        
        // This is internal because no explicit access level modifier is used
        static func internalFunc() {}
    }
}

// Extension has no explicit access level modifier and therefore it is internal
// so each top level member "inherits" that access level.
extension APublic.BPublic {
    
    public static func publicFuncAddedInExtenion() {} // NEW: extending nested type
    
    class CInternal {
        public static func publicFunc() {}
    }
}

extension APublic.BPublic.CPublic {
    public static func publicFuncAddedInExtenion() {} // NEW: extending nested type

    static func internalFuncAddedInExtenion() {}
    
    private static func privateFuncAddedInExtenion() {}
}

private extension APublic.BPublic.CInternal {
    private class DPrivate {
        init() {}
    }
    
    // compiles but `DPublic` will not be accessible as it is defined in a private extension
    public class DPublic {
        public init() {}
    }
}

Expected output

Note: extensions will always be rendered/processed no matter what elements.havingAccessLevel you specify in configuration.

• Reason: extensions may not have an explicit access-level modifier, i.e. any type members added in an extension have the same default access level as type members declared in the original type being extended but also it is possible to set explicitly set an access level for type member declaration.
• Example: extension APublic.BPublic adding new type members have a default access level of internal but you can add also public or private type members. Hiding extension APublic.BPublicwhen specifyingelements.havingAccessLevel = public` would potentially result in loss of information as the extension may have added public-type members

elements:
  showNestedTypes: true
  showExtensions: all
  havingAccessLevel:
  - public
  - internal
  - private

elements:
  showNestedTypes: true
  showExtensions: all
  havingAccessLevel:
  - public
  - internal

elements:
  showNestedTypes: true
  showExtensions: all
  havingAccessLevel:
  - public

elements:
  showNestedTypes: true
  showExtensions: merged
  havingAccessLevel:
  - public
  - internal
  - private

elements:
  showNestedTypes: true
  showExtensions: merged
  havingAccessLevel:
  - public
  - internal

elements:
  showNestedTypes: true
  showExtensions: merged
  havingAccessLevel:
  - public

elements:
  showNestedTypes: false
  showExtensions: all
  havingAccessLevel:
  - public
  - internal
  - private

Members of an extension do not show an access level indicator if there is no explicit access level modifier.

class aClass {
    var computedProperty: String {}
    func aFunction() {}
}

extension aClass {
    var extComputedProperty: String { "" }
    func extFunction()
}

The implicit access level for extComputedProperty and extFunction is internal. Therefore indicator ~ shall be represented in PlantUMLScript.

Current (unexpected) output

@startuml
' STYLE START
hide empty members
skinparam shadowing false
' STYLE END


class "aClass" as aClass << (C, DarkSeaGreen) >> { 
  ~computedProperty : String
  ~aFunction() 
}
class "aClass" as aClass0 << (X, Orchid) extension >> { 
  extComputedProperty : String
  extFunction()
}

aClass <.. aClass0 : ext
@enduml

Expected output

@startuml
' STYLE START
hide empty members
skinparam shadowing false
' STYLE END


class "aClass" as aClass << (C, DarkSeaGreen) >> { 
  ~computedProperty : String
  ~aFunction() 
}
class "aClass" as aClass0 << (X, Orchid) extension >> { 
  ~extComputedProperty : String
  ~extFunction()
}

aClass <.. aClass0 : ext
@enduml

Thanks for your efforts, this is a great tool.

I'm curious if there's any way to incorporate generating an entity relationship diagram. That would really open up some visual information.

Today it is possible to show or hide extensions. There should be a third option, i.e. to merge extensions (with their known type)

Even if extensions are merged, the extension members (computed properties, function) should be distinguishable from the main type definition. This can be achieved with a visual indicator.

Show Extensions (Default)	Merge Extensions (NEW)	Hide Extensions
Clutter but represents codebase accurately	Reduced clutter. No loss of information	No clutter but loss of information

I tried to generate the diagrams for a large project. I couldn't see the result in my browser.
So, I tried saving the console report in a file and then running plantuml to get the diagram.
But not it gives me this error:
Error line 9428 in file: diagram.plant
and here is that line:
Handler<Void, [SelectedTenant]> <|-- FetchTenantHandler : inherits
Is there anything wrong with this line?

If subclasses and/or extensions are scanned before their parent class then the class diagram gets generated incorrectly.

Example

class aClass: aProtocol {
    var computedProperty: String { "" }
    func aFunction() {}
}

protocol aProtocol {
    func aProtFunction() {}
}

Current (unexpected) output

Expected output

Previously it was possible to include a 3rd party theme through the !include directive and that was reflected in SwiftPlantUML by includeRemoteURL option in yml configuration.

Nowadays PlantUML has !theme directive and ships with many built-in themes. See https://plantuml.com/theme for further details

The goal is to cover those built-in themes

Visualize generic types and their type constraints. This can be realized as PlantUML supports Generics.

Example

class A<U> {}

final class B<U>: A<U> {}

struct ObjectItemSwiftUIView<Title: View, SubTitle: View> {}

Hello,

I'm seeking a method to visualize all the classes in my project but also identify dependencies \ relationship. (basically which class calls another.)

Is it possible to achieve this with the tool?
For example, scanning Car.swift will produce something similar to

+-------------------+        +-------------------+       +----------------------+
|   Music           |  <--   |   Car             | -->   |   Engine             |
+-------------------+        +-------------------+       +----------------------+
| + startMusic()    |        | + startCar()      |       | + startEngine()      |
+-------------------+        +-------------------+       +----------------------+

class Car {
    static func startCar() {
        print("Car started")
        Engine.startEngine()
        Music.startMusic()
    }
}

class Music {
    static func startMusic() {
        print("Music started")
    }
}

class Engine {
    static func startEngine() {
        print("Engine started")
    }
}

Hello,
I am not quite sure if it is a bug or something to improve, but I am trying to export a diagram for the whole project. I get the URL error below:
Request-URI Too Long
The requested URL's length exceeds the capacity limit for this server.
Apache/2.4.41 (Ubuntu) Server at planttext.com Port 443

Url is, really pages long because of the codebase size, but I don't know if it is possible to make it otherwise. Should I use the CLI tool for every module or is there a better way of doing it?

Note: I found the output option; if I make it console-only, I can use it. It sounds good to have and I get the UML text exported, however, maybe it is possible to fix the browser options somehow? Wondering if you had the problem in mind.

Also note, planttext cannot create the big UML diagram that I exported so it is their problem actually.

Thanks in advance, the project is really cool I would like to use it in my career.

When setting relationships between elements, it turns out that A+--B and A+--B yield different results visually. Not using spaces even results in errors. Please have a look at the attached images. SwiftPlantUML doesn't include spaces in the relationships.

Repository i'm trying to get UML of:
https://github.com/WalletConnect/WalletConnectSwift

Installed SwiftPlantUML via brew on macOS

Commands i tried:

• swiftplantuml
• swiftplantuml classdiagram
• swiftplantuml classdiagram Sources

Error i get:

SourceKittenFramework/library_wrapper.swift:31: Fatal error: Loading sourcekitd.framework/Versions/A/sourcekitd failed

illegal hardware instruction  swiftplantuml classdiagram Sources

Configure generation of PlantUML script and with a configuration file (.yml) .

• specify built-in PlantUML options, e.g. skinparam shall be covered.
• allow SwiftPlantUML specific options, e.g. including elements (class, struct, enum, ...) in PlantUML script based on their access level.

Example:

output: browser
files:
  include:
  - Sources/SwiftPlantUMLFramework/Plant*.swift
  exclude:
  - Tests
generateElementsWithAccessLevel:
- public
- internal
- private
generateMembersWithAccessLevel:
- public
- internal
- private
showGenerics: true
hideShowCommands:
- hide empty members
skinparamCommands:
- skinparam shadowing false
relationships:
  struct:
    lineStyle: bold
    lineColor: AliceBlue
    textColor: AntiqueWhite
relationshipLabels:
  inheritance: inherits
  realize: confirms to
  dependency: ext
stereotypes:
  class:
    spot:
      character: C
      color: DarkSeaGreen
  struct:
    name: struct
    spot:
      character: S
      color: SkyBlue
  extension:
    name: extension
    spot:
      character: X
      color: Orchid
  enum:
    name: enum
    spot:
      character: E
      color: LightSteelBlue
  protocol:
    name: protocol
    spot:
      character: P
      color: GoldenRod

The plan is to support a single configuration file for the file scanning process. Multiple/Nested configuration files like in SwiftLint (Reference) is not planned.

After installing with brew, running swiftplantuml classdiagram --help produces command not found: swiftplantuml. There is no executable in usr/local/bin (or anywhere on my system that I can find), only an app is installed in the Applications directory and Xcode extension added

See MarcoEidinger/SwiftPlantUML-Xcode-Extension#29

I tried to build the CLI tool as described by I get the following error (MacOS 10.15.7):
SwiftPlantUML git:(main) make install
Fetching https://github.com/jpsim/Yams.git
Fetching https://github.com/jpsim/SourceKitten
Fetching https://github.com/apple/swift-argument-parser.git
Fetching https://github.com/drmohundro/SWXMLHash.git
Cloning https://github.com/drmohundro/SWXMLHash.git
Resolving https://github.com/drmohundro/SWXMLHash.git at 5.0.1
Cloning https://github.com/apple/swift-argument-parser.git
Resolving https://github.com/apple/swift-argument-parser.git at 0.3.2
Cloning https://github.com/jpsim/SourceKitten
Resolving https://github.com/jpsim/SourceKitten at 0.31.0
Cloning https://github.com/jpsim/Yams.git
Resolving https://github.com/jpsim/Yams.git at 4.0.4
[15/15] Linking swiftplantuml
install: : No such file or directory
make: *** [install] Error 71

In my case I have a class-container (Class1) and another class (Class2) which is not directly linked with Class1.

Now I need to figure out how to pass Class2 to Class1. It seems the simplest way is:
1)find all the paths between Class1 and Class2 in this generated graph with the specified max lenght in text format
2)find the class container which contains Class1 and Class2 objects (directly or indirectly)

Is it possible to do with your tool?