typst / typst/package-check

Opt out mechanism for diagnostics

Open
#55 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
36
Forks
9
Avg merge
1h 46m
Merged PRs (30d)
1

Description

Add some opt out mechanism for warnings that the package chooses to ignore, such as the kebab-case checks. This would remove some of the review noise. It might make sense to only allow disabling a set of diagnostics, for example only some warnings, and no errors.

One way this could be implemented would be to add an entry in the manifest under tool.package-check.

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 reviewing how the package manifest's tool.package-check entry could represent diagnostic settings and how warnings differ from errors. Define which diagnostics may be disabled while errors remain enabled, then confirm the behavior removes selected warning noise without suppressing errors.

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
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.