PlantUML stdlib snippets for vscode

This extension provides you number of the dummy code snippets for PlantUML standard library https://plantuml.com/stdlib

Supported stdlib extensions

Idea for the snippets is to speedup time needed to recall how is called your favorite icon from stdlib and use it in your plantuml diagram. Depending on a stdlib library used you might need to invoke following steps:

a) Invoke required "include-common" macros which initializes diagram for subsequent library objects.

Usually you are starting to type i- (which is shortened for include-) followed by library and word common. Note that VSCode is smart enough to do a fuzzy search, thus you could just time smth like iawscommon in one word

b) Include icons that will be used in your diagram

On that moment you should briefly recall what kind of object you want to draw in your diagram. Thus you could look for either part of the object name i-aws-efsfilesystem_large, group and object name i-aws-Storage-efsfilesystem.

c) Now you can insert object itself

usual text to be used in fuzzy search would be library code - object name aws-amazonefs. As usually vscode smart enough, thus you can use quite fuzzy combination of words.

Notes on a specific libraries

aws

As seen on a screen recording below, usually you are supposed to have some prototype of the future diagram in raw plant uml, and use stdlib/aws to provide greater visualization to the diagram. On a moment when you want to include some icon, you start snippet search with ia followed by icon topic or name. On a moment, when you want to use icon itself, you just start typing approximate icon name. The one in appercase will be the needed one

awslib

That extension is kind of official "icons" released under https://github.com/awslabs/aws-icons-for-plantuml ; It appeared later than aws and the most notible difference from classic aws lib is presence of the cumulative include all files with sprites divided in a limited set of areas. You could also distinguish icons from that set by selecting AWS entity in a CamelCase.

For a simplicity, we introduce few additional "meta" snippets, which are ial-all - include all of the categories and ial-all-mostused - opinionated "most used" by myself

Diagrams constructed with this extension look like "Azure" ones

azure

That extension is kind of official "icons" released under https://github.com/RicardoNiepel/Azure-PlantUML; Also supports categoru includes, thus "meta" snippets, which are i-azure-all - include all of the categories and i-azure-mostused - opinionated "most used" by myself are also included. The most easiest way to start typing Azure entity name and select corresponding one

c4

NOT included, because it has own supported snippets for visual studio code

cloudinsight

Usually used as a sprites to provide better appearence for classic rectangles. You generally could search for the snippet via i-cloudinsight-topic , of topic is found you can use it in your diagram. Number of sprites around 50, but you might be lucky.

Can be used with deployment diagram terms https://plantuml.com/deployment-diagram , if you are looking for standalone object, proceed with logos

@startuml
!include <cloudinsight/tomcat>
!include <cloudinsight/kafka>
!include <cloudinsight/java>
!include <cloudinsight/cassandra>


title Cloudinsight sprites example

skinparam monochrome true

rectangle "<$tomcat>\nwebapp" as webapp
queue "<$kafka>" as kafka
rectangle "<$java>\ndaemon" as daemon
database "<$cassandra>" as cassandra

webapp -> kafka
kafka -> daemon
daemon --> cassandra
@enduml

clouddogu

https://github.com/cloudogu/plantuml-cloudogu-sprites

Around 50 sprites, mostly related to devops. You should generally could look for term with i-co-term and then insert term in uppercase.

@startuml
!include <cloudogu/common>
!include <cloudogu/dogus/redmine>
!include <cloudogu/tools/ansible>

DOGU_REDMINE(e_alias, "e_label")
TOOL_ANSIBLE(zz, "e_label")
@enduml

elastic

https://github.com/Crashedmind/PlantUML-Elastic-icons

Tons of entities related to elasticsearch architecture, group level includes are not supported. Thus you first reference entity by searching i-es-entityname and using entity in diagram. Object snippets are uppercased.

@startuml
!include <elastic/common>
!include <elastic/elasticsearch/elasticsearch>

ELASTICSEARCH(e_alias, "e_label")

@enduml

kubernetes

NOT included but planned (harder to parse composition of sprites)

logos

Number of different logos from the real world. You first reference logo by searching i-logo-term. If term is found, you can use it

@startuml
!include <logos/atlassian>

e_alias: <$atlassian> e_desc

@enduml

Unfortunately, can be used in deployment diagram

material

Around hundred of different icons similar to logs, but in google material theme. Can be combined with deployment diagram. You need a bootstraper, i.e. include common library and reference separately all used icons. (Find them with i-material)

In order to insert object, all snippets start with MA_, uppercased, so quite easy to find macros.

@startuml
!include <material/common>
!include <material/atlassian>

MA_ATLASSIAN(Red, 1, dir, rectangle, "A label")

@enduml

office

https://github.com/Roemer/plantuml-office

Set of icons which might help you to better visualize, for example, deployment diagram. Quite large number of terms. First you could try to look for object with i-off-term. If found, you can use entity by looking for a snippet starting with OFF_ and uppercase. Just a gentle reminder, vscode supports fuzzy search.

Shares common library for different project, thus needs to be included first (!include <tupadr3/common> - macros i-off-common)

Objects can be combined with deployment diagram (rectangle, database and so on)

@startuml
!include <tupadr3/common>
!include <office/Concepts/bandwidth_calculator>

OFF_BANDWIDTH_CALCULATOR(e_alias, "e_label")

@enduml

osa

https://github.com/Crashedmind/PlantUML-opensecurityarchitecture-icons

The nice set of icons for DevSecOps, but unfortunately I failed to find any compatible diagram, so OSA diagram can use only OSA sprites

@startuml
!include <osa/laptop/laptop>
!include <osa/vpn/vpn>
!include <osa/user/green/architect/architect>

Laptop: <$laptop>
Laptop2: <$laptop>

Laptop--->Laptop2

ealias: <$vpn>

architect: <$architect>

@enduml

tupadr3

https://github.com/tupadr3/plantuml-icon-font-sprites

The following icon sets are included:

Requires common file to be included, you can use snippet i-t3-common , every icon has a prefix related to one of the sets above, i.e. FA_, FA5_, DEV_, GOV_, WEATHER_, MATERIAL_

I am usually searching for a icon to include with i-t3-term, if found I then reference the icon by searching the uppercased term. The icon, which starts with one of the prefixes above most likely is the one you looking for.

All the icons can be used with deployment diagrams.

@startuml
!include <tupadr3/common>
!include <tupadr3/devicons/android>

component SomeComponent {
DEV_ANDROID(e_alias, "e_label")
}

@enduml