Change ordering of fields in typst.toml (discussion would be useful) #6
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current
typst.toml
is missing some optional fields and IMO also orders them in a strange way (for example, there are four keys betweenkeywords
andcategories
, which are both about discoverability of packages via tag-like classifications). This PR changes the order to reflect what's described in typst/packages. It also links that page in the file for reference.Although the order in the packages repo is a minimally opinionated default, I could also imagine some tweaks. Personally, I have the following comments:
description
earlier, somewhere betweenname
andlicense
compiler
directly afterentrypoint
homepage
is relatively rare, so I could imagine commenting it out by defaultexclude
being last, it feels the least informative to a reader[template]
could be removed, but the example contains useful defaults so I think it's worth keeping[tool.mytool]
could be removed or replaced by[tool.typst-test]
- then it's a useful default and an example at the same time