coekjan / typst-upgrade

Upgrade your typst packages

Typst Upgrade

Help you to upgrade your Typst Packages.

Usage

To upgrade your typst-package dependencies, you can use the following command (assuming your project located in /path/to/your/project):

$ typst-upgrade /path/to/your/project

See typst-upgrade --help for more information:

$ typst-upgrade --help
A tool to upgrade typst packages

Usage: typst-upgrade [OPTIONS] <TYPST_ENTRY_PATHS>...

Arguments:
  <TYPST_ENTRY_PATHS>...  

Options:
  -d, --dry-run        Dry run without editing files
  -i, --incompatible   Allow incompatible upgrades
      --color <COLOR>  [default: auto] [possible values: auto, always, never]
      --diff <DIFF>    [default: short] [possible values: short, full, none]
  -v, --verbose        Print more information
  -h, --help           Print help
  -V, --version        Print version

Installation

Cargo

You can install typst-upgrade via cargo:

$ cargo install typst-upgrade

Or if you use cargo-binstall, you can install typst-upgrade via cargo binstall:

$ cargo binstall typst-upgrade

Prebuilt Binaries

You can download the prebuilt binaries from the release page.

License

Licensed under the MIT License.

typst-upgrade's Issues

in-place upgrade typst files

This helps to avoid manually editing typst files

add more complex testcases & report coverage

Don't use cwd as cli default path

If someone runs the cli without any arguments in $HOME, the tool may damage the system!

Use json files hosted by typst team to query packages version

If using these json files, we can no longer deal with GitHub API!

• url: https://packages.typst.org/preview/index.json or https://packages.typst.org/preview/index.full.json
• schema: https://github.com/typst/packages/blob/main/bundler%2Fsrc%2Fmodel.rs

`.typc` is not typst extension