Skip to content

v0.1.0

Choose a tag to compare

@github-actions github-actions released this 08 Oct 16:14
· 9 commits to main since this release
v0.1.0
3b4a077

First official release of typush, a CLI tool for developing, validating, and publishing Typst packages.

Key Features

  • Package Scaffolding (typush init): Interactively generates typst.toml, default entrypoint src/lib.typ, README.md, and LICENSE. Automatically infers git author (Name <email>) and repository HTTPS URL from git configuration. Supports template packages with customizable template directories and entrypoints.
  • Local Development and Debugging (typush dev, typush dev list, typush clean): Symlinks the current package directory into the local @preview namespace, allowing other local Typst documents to #import and test changes in real time without reinstallation. dev list displays all active symlinks and resolved targets; clean removes development links with optional --dry-run preview.
  • Local Specification and Compiler Verification (typush check): Replicates official Universe CI validation locally and offline. Verifies package metadata (kebab-case, SemVer, SPDX license expressions, allowed categories and disciplines), documentation links and image alt text, forbidden font files (.ttf/.otf), and runs isolated compilation checks when typst is installed.
  • Version Bumping (typush bump): Increments or sets package.version in typst.toml using patch, minor, major, or explicit version arguments, enforcing anti-downgrade checks and updating self-referential package versions in README.md.
  • Universe Submission (typush publish universe): Automates pull request submission to the official typst/packages repository. Uses GitHub CLI (gh) for authentication, provisions user forks, utilizes Git sparse-checkout to upload only the package directory in a single commit, and opens pre-checked Draft Pull Requests.
  • Pull Request and CI Tracking (typush pr status, typush pr checks): Displays PR metadata and reviewer comments, and monitors official upstream GitHub Actions check runs with optional -w, --watch waiting.

Installation

Using Go:

go install github.com/Vncntvx/typush@v0.1.0

Or download precompiled binaries for macOS, Linux, and Windows from the Assets below.

Acknowledgments

Thanks to @maxchang3 in PR #1 for contributing the Git Trees API directory traversal fix.