Pablo-Gonzalez-Calderon / showybox-package

A Typst package for creating colorful and customizable boxes
MIT License
50 stars 5 forks source link

Updated version in typst.toml #17

Closed Andrew15-5 closed 12 months ago

Andrew15-5 commented 12 months ago

Current version in README.md is 1.2.0, but typst.toml has 1.0.0.

P.S. Which means, that version 1.1.0 also had 1.0.0 in typst.toml.

Pablo-Gonzalez-Calderon commented 12 months ago

The typst.toml information is changed once all the new changes are ready and the version number is correctly defined. Aparently I forgot to change it in this repo, but in the official Typst packages repo is correct (usually this is a last-minute-change I made locally in my computer)

Current developing version still have some things to be changed, so the toml file won't be updated at the moment, because there's no certainty the changes will have backward compatibility.

In Typst package's main repo they recommend this versioning scheme, so I still have to wait if the changes are significant.

Also, changing it to 1.1.0 wouldn't be useful, as 1.1.0 local release will still have the wrong version.

Anyways, thank you for noticing 😉

Andrew15-5 commented 12 months ago

The problem is that in README.md use say to use #import "@preview/showybox:1.2.0": showybox. If I want to check dev changes, I can download it and use as a @local package. I created dirs showybox/1.2.0, but then the compiler compilers says:

error: package manifest contains mismatched version 1.0.0
  ┌─ file.typ:2:8
  │
2 │ #import "@local/showybox:1.2.0": showybox
  │         ^^^^^^^^^^^^^^^^^^^^^^^

So, if you don't want to change typst.toml, then you should at least revert version in the README.md. It's strange to tell people to use a package with one version, but keep another version in the package manifest (even though the new version is still in development).

I either have to change the version in your typst.toml (locally) or rename dir to 1.0.0 which is confusing, since main branch contains v1.1.0 + v1.2.0.

Pablo-Gonzalez-Calderon commented 12 months ago

Hmmm. That's a good point. I've never used the package locally in that way. I'll update the toml file then 😅

Thank you!