search

typst-community / typst-package-template

The Unlicense
10 stars 7 forks source link

don't exclude README and CHANGELOG (and also Justfile) #13

Closed SillyFreak closed 5 months ago

SillyFreak commented 5 months ago

this removes the three items from exclude in typst.toml. The former two should be part of the published package; the latter should not even make it into the PR to universe and thus doesn't need to be excluded.

A possible alternative point of view is that the package script which uses .typstignore should not be assumed, and thus things like tests and Justfile should be put into exclude. Personally, I think that even when not using that script, these things don't belong into the PR and thus putting them in exclude sends the wrong signal, but it's not a strong preference.

Fixes #12

tingerrr commented 5 months ago

My reasoning for putting them there was actually future proofing, since copying the files into the package repo is more or less a temporary solution. Typst will eventually have a proper publish workflow which would reasonably reuse this to exclude files while publishing.

SillyFreak commented 5 months ago

exclude and what is submitted to Universe have (at least currently) different meanings though, see here: https://github.com/typst-community/typst-package-template/issues/12#issuecomment-2173532358

it can still make sense to defensively exclude a lot (but not README, at the very least) but there are files that should be excluded, yet definitely submitted to Universe

edit: wait, wasn't it James who chose the current list of ignored files?

tingerrr commented 5 months ago

it can still make sense to defensively exclude a lot (but not README, at the very least) but there are files that should be excluded, yet definitely submitted to Universe

Yeah, I'm with you on that matter, I think the README should not be excluded.

edit: wait, wasn't it James who chose the current list of ignored files?

The repo structure was copied from valkryie, where I added most of the scaffolding like Justfile, tests workflow, and excludes from my packages.

You're definitely right about excluded and submitted being different things, which is a little annoying from a developer standpoint. I think most developers at this point just copy the whole repo verbatim, so a defensive exclude list could be beneficial.

SillyFreak commented 5 months ago

Ok, then I'll add everything in typstignore to exclude as well

jamesrswift commented 5 months ago

LGTM!

SillyFreak commented 5 months ago

@tingerrr @JamesxX would either of you merge this? I can't do it myself