typst / typst/packages

Ignore reads configuration files

Open
#4,157 0 comments 0 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

The ignore crate reads .gitignore files (and others) to know which files to list or not. It means that some files that are not listed under package.exclude in the manifest may still be excluded "silently" if a .gitignore is copied to the package directory. It happened here for example.

The crate allows to disable this feature (and other similar behaviors). But that would mean that previously bundled packages may contain different files when the new version of the bundler runs again, which would break reproducibility.

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 tracing the package bundler's use of the Rust ignore crate and reviewing the linked WalkBuilder documentation, especially git_ignore and standard_filters. Compare that behavior with package.exclude and the reproducibility requirement; done means the intended handling of copied .gitignore files is decided and documented or covered by the relevant bundler checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
build-system
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.