{"id":16573880,"url":"https://github.com/leobenkel/umlclassdiagram","last_synced_at":"2025-03-21T12:31:29.808Z","repository":{"id":40304585,"uuid":"457894258","full_name":"leobenkel/umlclassdiagram","owner":"leobenkel","description":"SBT Plugin to draw a UML Class Diagram","archived":false,"fork":false,"pushed_at":"2024-08-19T16:29:01.000Z","size":94,"stargazers_count":19,"open_issues_count":8,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-10-12T21:43:14.908Z","etag":null,"topics":["class-diagram","dotfiles","graph","sbt-plugin","scala"],"latest_commit_sha":null,"homepage":"https://github.com/leobenkel/umlclassdiagram","language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/leobenkel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"github":null,"patreon":"leobenkel","open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2022-02-10T18:10:15.000Z","updated_at":"2024-08-01T07:14:07.000Z","dependencies_parsed_at":"2023-02-19T10:16:05.759Z","dependency_job_id":null,"html_url":"https://github.com/leobenkel/umlclassdiagram","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leobenkel%2Fumlclassdiagram","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leobenkel%2Fumlclassdiagram/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leobenkel%2Fumlclassdiagram/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leobenkel%2Fumlclassdiagram/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/leobenkel","download_url":"https://codeload.github.com/leobenkel/umlclassdiagram/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221815150,"owners_count":16885130,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["class-diagram","dotfiles","graph","sbt-plugin","scala"],"created_at":"2024-10-11T21:43:18.934Z","updated_at":"2024-10-28T10:07:34.700Z","avatar_url":"https://github.com/leobenkel.png","language":"Scala","funding_links":["https://patreon.com/leobenkel","https://www.patreon.com/leobenkel"],"categories":[],"sub_categories":[],"readme":"\n\n![umlclassdiagram example][umlclassdiagram-img]\n\n# UML Class Diagram for Scala\n\n\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![release-badge][]][release]\n[![maven-central-badge][]][maven-search]\n[![CI-CD](https://github.com/leobenkel/umlclassdiagram/workflows/CI-CD/badge.svg)](https://github.com/leobenkel/umlclassdiagram/actions/workflows/ci_cd.yml)\n[![BCH compliance](https://bettercodehub.com/edge/badge/leobenkel/umlclassdiagram?branch=main)](https://bettercodehub.com/)\n[![Coverage Status](https://coveralls.io/repos/github/leobenkel/umlclassdiagram/badge.svg?branch=main)](https://coveralls.io/github/leobenkel/umlclassdiagram?branch=main)\n\n\n[release]:              https://github.com/leobenkel/umlclassdiagram/releases\n[release-badge]:        https://img.shields.io/github/tag/leobenkel/umlclassdiagram.svg?label=version\u0026color=blue\n[maven-search]:         https://search.maven.org/artifact/com.leobenkel/umlclassdiagram\n[leobenkel-github-badge]:     https://img.shields.io/badge/-Github-yellowgreen.svg?style=social\u0026logo=GitHub\u0026logoColor=black\n[leobenkel-github-link]:      https://github.com/leobenkel\n[leobenkel-linkedin-badge]:     https://img.shields.io/badge/-Linkedin-yellowgreen.svg?style=social\u0026logo=LinkedIn\u0026logoColor=black\n[leobenkel-linkedin-link]:      https://linkedin.com/in/leobenkel\n[leobenkel-personal-badge]:     https://img.shields.io/badge/-Website-yellowgreen.svg?style=social\u0026logo=data:image/svg+xml;base64,PHN2ZyBoZWlnaHQ9JzMwMHB4JyB3aWR0aD0nMzAwcHgnICBmaWxsPSIjMDAwMDAwIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHhtbG5zOnhsaW5rPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5L3hsaW5rIiB2ZXJzaW9uPSIxLjEiIHg9IjBweCIgeT0iMHB4IiB2aWV3Qm94PSIwIDAgNjQgNjQiIGVuYWJsZS1iYWNrZ3JvdW5kPSJuZXcgMCAwIDY0IDY0IiB4bWw6c3BhY2U9InByZXNlcnZlIj48Zz48Zz48cGF0aCBkPSJNNDEuNiwyNy4yYy04LjMsMC0xNSw2LjctMTUsMTVzNi43LDE1LDE1LDE1YzguMywwLDE1LTYuNywxNS0xNVM0OS45LDI3LjIsNDEuNiwyNy4yeiBNNTEuNSwzNmgtMy4zICAgIGMtMC42LTEuNy0xLjQtMy4zLTIuNC00LjZDNDguMiwzMi4yLDUwLjIsMzMuOSw1MS41LDM2eiBNNDEuNiwzMS41YzEuMywxLjIsMi4zLDIuNywzLDQuNGgtNkMzOS4zLDM0LjIsNDAuNCwzMi43LDQxLjYsMzEuNXogICAgIE0zNy40LDMxLjNjLTEsMS40LTEuOCwyLjktMi40LDQuNmgtMy4zQzMzLjEsMzMuOSwzNS4xLDMyLjIsMzcuNCwzMS4zeiBNMzAuMyw0NWMtMC4yLTAuOS0wLjQtMS44LTAuNC0yLjhjMC0xLDAuMS0yLDAuNC0yLjkgICAgaDMuOWMtMC4xLDEtMC4yLDEuOS0wLjIsMi45YzAsMC45LDAuMSwxLjksMC4yLDIuOEgzMC4zeiBNMzEuNyw0OC4zSDM1YzAuNiwxLjcsMS40LDMuNCwyLjQsNC44QzM1LDUyLjIsMzMsNTAuNSwzMS43LDQ4LjN6ICAgICBNNDEuNiw1Mi45Yy0xLjMtMS4yLTIuMy0yLjgtMy4xLTQuNWg2LjFDNDQsNTAuMSw0Mi45LDUxLjcsNDEuNiw1Mi45eiBNMzcuNiw0NWMtMC4yLTAuOS0wLjItMS44LTAuMi0yLjhjMC0xLDAuMS0yLDAuMy0yLjloOCAgICBjMC4yLDAuOSwwLjMsMS45LDAuMywyLjljMCwxLTAuMSwxLjktMC4yLDIuOEgzNy42eiBNNDUuOCw1My4xYzEtMS40LDEuOC0zLDIuNC00LjhoMy4zQzUwLjIsNTAuNSw0OC4yLDUyLjIsNDUuOCw1My4xeiBNNDksNDUgICAgYzAuMS0wLjksMC4yLTEuOCwwLjItMi44YzAtMS0wLjEtMi0wLjItMi45aDMuOWMwLjIsMC45LDAuNCwxLjksMC40LDIuOWMwLDEtMC4xLDEuOS0wLjQsMi44SDQ5eiI+PC9wYXRoPjxwYXRoIGQ9Ik0zNCwyNS45Yy0wLjktMC43LTEuOC0xLjMtMi45LTEuOGMyLTIuMSwzLjItNC45LDMuMi03LjljMC02LjMtNS4xLTExLjQtMTEuNC0xMS40UzExLjYsOS45LDExLjYsMTYuMiAgICBjMCwzLjEsMS4yLDUuOSwzLjIsNy45Yy00LjEsMi02LjgsNS40LTcuMSw5LjRsLTAuMywzLjhjMCwyLDcsMy42LDE1LjYsMy42YzAuMiwwLDAuNSwwLDAuNywwQzI0LjIsMzQuMywyOC4yLDI4LjYsMzQsMjUuOXogICAgIE0yMyw4LjhjNC4xLDAsNy40LDMuMyw3LjQsNy40cy0zLjMsNy40LTcuNCw3LjRzLTcuNC0zLjMtNy40LTcuNFMxOC45LDguOCwyMyw4Ljh6Ij48L3BhdGg+PC9nPjwvZz48L3N2Zz4=\u0026logoColor=black\n[leobenkel-personal-link]:      https://leobenkel.com\n[leobenkel-patreon-link]:            https://www.patreon.com/leobenkel\n[leobenkel-patreon-badge]: https://img.shields.io/badge/-Patreon-yellowgreen.svg?style=social\u0026logo=Patreon\u0026logoColor=black\n[maven-central-link]:           https://maven-badges.herokuapp.com/maven-central/com.leobenkel/umlclassdiagram\n[maven-central-badge]:          https://maven-badges.herokuapp.com/maven-central/com.leobenkel/umlclassdiagram/badge.svg\n\n[umlclassdiagram-img]: https://raw.githubusercontent.com/leobenkel/umlclassdiagram/main/assets/umlclassdiagram-classDiagram-internal.png\n\n\nInspired by [xuwei-k/sbt-class-diagram](https://github.com/xuwei-k/sbt-class-diagram)\n\n## Table of Contents\n\n* [Setup](#setup)\n   * [Requirements](#requirements)\n   * [Enable plugin](#enable-plugin)\n   * [Which connections would you like to show?](#which-connections-would-you-like-to-show)\n   * [Styling](#styling)\n* [Use](#use)\n* [Settings](#settings)\n   * [To open the folder with output files and/or the SVG image](#to-open-the-folder-with-output-files-andor-the-svg-image)\n   * [To change the name of the file](#to-change-the-name-of-the-file)\n* [Authors](#authors)\n    * [Leo Benkel](#leo-benkel)\n\nTable of content generated by [gh-md-toc](https://github.com/ekalinin/github-markdown-toc)\n\n## Setup\n\n### Requirements\n\nYou are required to install [Graphviz](https://www.graphviz.org/) to generate the SVG from the dot file.\n\nIf you do not need the generation of the SVG file, you can apply this setting:\n\n```scala\nclassDiagramSettings := classDiagramSettings.value.copy(generateSvg = false)\n```\n\nin your `build.sbt`.\n\n### Enable plugin\n\nFirst add \n\n```scala\naddSbtPlugin(\"com.leobenkel\" % \"umlclassdiagram\" % \"[VERSION]\")\n```\n\nto `project/plugin.sbt`\n\nVersion: [![maven-central-badge][]][maven-search]\n\nand then \n\n```scala\nenablePlugins(UmlClassDiagramPlugin)\n```\nto `build.sbt`\n\n### Which connections would you like to show?\n\nTo change which connection you would like to display, add this:\n```scala\n\nclassDiagramSettings :=\n  classDiagramSettings\n    .value\n    .copy(\n      enabledConnectionTypes =\n        Set(\n          com.leobenkel.umlclassdiagram.internal.ConnectionType.Inherit,\n          com.leobenkel.umlclassdiagram.internal.ConnectionType.Produce,\n          com.leobenkel.umlclassdiagram.internal.ConnectionType.Consume,\n          com.leobenkel.umlclassdiagram.internal.ConnectionType.Throw,\n          com.leobenkel.umlclassdiagram.internal.ConnectionType.Enclosing,\n        ),\n    )\n```\n\nto your `build.sbt`.\n\nThe possibilities are:\n\n* **Inherit**\n  * will connect the classes with their parent trait and classes\n  * This is the **default** behavior.\n* **Produce**\n  * Will connect the classes to the classes that can be returned\n  * Will not find out about generic type like `Seq[A]` or `Foo[A]`\n* **Consume**\n  * Will connect the classes to the classes that are used as arguments\n* **Throw**\n  * Will connect the classes to the classes being thrown\n* **Enclosing**\n  * Will connect the classes to the parent class where the class is defined is it exist.\n\n### Styling\n\nYou can read more about the key/values available for dot graph styling with this document: https://www.graphviz.org/pdf/dotguide.pdf .\n\n## Use\n\nTo analyze a specific class:\n\n```bash\nsbt classDiagram path.to.Class\n```\n\nTo browse entire package:\n\n```bash\nsbt classDiagram path.to.package.*\n```\n\nAnd those can be combined:\n\n```bash\nsbt classDiagram path.to.Class path.to.package.* pack.to.other.Class\n```\n\n## Settings\n\n### To open the folder with output files and/or the SVG image\n\n```scala\nclassDiagramSettings := classDiagramSettings.value.copy(openFolder = true, openSvg = true)\n```\n\nin your `build.sbt`.\n\n### To change the name of the file\n\n```scala\nclassDiagramSettings := classDiagramSettings.value.copy(name = \"foo\")\n```\n\nin your `build.sbt`.\n\n## Authors\n\n### Leo Benkel\n\n* [![leobenkel-github-badge][]][leobenkel-github-link]\n* [![leobenkel-linkedin-badge][]][leobenkel-linkedin-link]\n* [![leobenkel-personal-badge][]][leobenkel-personal-link]\n* [![leobenkel-patreon-badge][]][leobenkel-patreon-link]\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleobenkel%2Fumlclassdiagram","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fleobenkel%2Fumlclassdiagram","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleobenkel%2Fumlclassdiagram/lists"}