Skip to content

source-to-class-diagram:0.1.0#4697

Open
leandro-costa wants to merge 7 commits into
typst:mainfrom
typst-things:main
Open

source-to-class-diagram:0.1.0#4697
leandro-costa wants to merge 7 commits into
typst:mainfrom
typst-things:main

Conversation

@leandro-costa
Copy link
Copy Markdown

@leandro-costa leandro-costa commented Apr 25, 2026

I am submitting

  • a new package

UML Class Diagrams for Typst, built on CeTZ. Supports Java and Csharp syntax with pluggable grammars.

I have read and followed the submission guidelines and, in particular, I

  • selected a name that isn't the most obvious or canonical name for what the package does
  • added a typst.toml file with all required keys
  • added a README.md with documentation for my package
  • have chosen a license and added a LICENSE file or linked one in my README.md
  • tested my package locally on my system and it worked
  • excluded PDFs or README images, if any, but not the LICENSE
  • ensured that my package is licensed such that users can use and distribute the contents of its template directory without restriction, after modifying them through normal use.

@typst-package-check typst-package-check Bot changed the title source-to-class-diagram source-to-class-diagram:0.1.0 Apr 25, 2026
@typst-package-check typst-package-check Bot added the new A new package submission. label Apr 25, 2026
Copy link
Copy Markdown
Member

@elegaanz elegaanz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this package :)

exclude = ["tests/", "docs/", "gallery/"]

[template]
path = "exemplos"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not entirely sure a template is relevant here. I feel like this is more a package that you would import in larger projects rather than something you want to use standalone. And even in that case, importing the package and applying the unique show rule is not really worth a template in my opinion. Is there a particular reason you may want to start a project from the setup in exemplos/?

@@ -0,0 +1,17 @@
[package]
name = "source-to-class-diagram"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This name is too descriptive, which we forbid. Can you please pick another name that is more distinctive and unique?

[package]
name = "source-to-class-diagram"
version = "0.1.0"
compiler = "0.14.2"
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The compiler field is a minimum version, so unless you explicitly require the latest patch release, changing it to 0.14.0 will allow using this package with a slightly outdated compiler. If you know for sure that you support older versions because you don't use any recent Typst feature, you can even use a lower version number.

@@ -0,0 +1,158 @@
# source-to-class-diagram

Geração de Diagramas de Classe UML a partir de código-fonte Java ou C# diretamente no Typst, construído sobre o engine CeTZ.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is generally appreciated to have at least the first sentence of the README in English to give a bit more context about the package to the broader Typst community. Here, since this package can be useful to people who don't speak Portuguese too, I even think it would be nice to have the full README in English (as this is the "default" language of the community). But I can understand that you may feel more comfortable using Portuguese: you don't have to translate the full README if you don't feel like doing it.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure what the purpose of that file is. In case it is no longer used, can you remove it please?

@saecki saecki added the waiting-on-author Pull request waits on author label May 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new A new package submission. waiting-on-author Pull request waits on author

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants