typst / typst/packages

Mark deprecated packages

Open
#1,393 3 comments 27 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
1k
Forks
1.3k
Avg merge
2d 22h
Merged PRs (30d)
189

Description

Description

It would be nice to notify the users to remove the deprecated dependencies, especially when the users update their typst compiler and try to use it to compile an existing document.


Maybe we can allow package authors and typst maintainers to add some metadata (e.g. deprecated-since: '0.12.0') for a package at preview/{package}/meta.toml. More metadata can be added in it, so this design is not limited to deprecate a package.

By this design, the compiler can check this metadata and issue warnings to users.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting the package metadata at preview/{package}/meta.toml and how the Typst compiler currently handles package metadata. Determine how a deprecation field should be represented and when users should receive warnings. Done means the metadata design and compiler warning behavior are defined and validated for the described package cases.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.