Skip to content

feat: add ty type checking to template - #21

Merged
mjun0812 merged 1 commit into
mainfrom
feat/add-ty-check
Sep 3, 2026
Merged

feat: add ty type checking to template#21
mjun0812 merged 1 commit into
mainfrom
feat/add-ty-check

Conversation

@mjun0812

Copy link
Copy Markdown
Owner

Overview and Background

Generated projects now include Astral's stable ty type checker as a locked development dependency and run it in continuous integration. Previously, template CI validated formatting, linting, and tests but did not perform static type checking.

Related Issues

None.

Implementation Approach

Add ty to the existing development dependency group and regenerate the template lockfile so generated projects install the exact checker version. Run the same frozen command in both the generated-project verification workflow and the generated template workflow, keeping local and CI checks aligned.

Changes

  • Add ty>=0.0.77 and its locked resolution to the template.
  • Add uv run --frozen ty check to template CI and generated-project verification CI.
  • Document type-checking setup and usage in the repository README, replacing the outdated note that ty was not stable.

Impact

Generated projects gain a static type-checking step in CI and an additional development dependency. Runtime behavior, Docker configuration, and existing formatting, linting, and test workflows are unchanged.

Validation Results

Validated a generated project from this branch with:

uv sync --locked
uv run --frozen ty check
uv run --frozen pytest -vs
uv run --frozen ruff format --check --diff .
uv run --frozen ruff check --output-format=github .

All checks passed, including ty reporting All checks passed! and pytest reporting 2 passed tests.

- Add locked ty development dependency to generated projects
- Run ty checks in template and generated-project CI workflows
- Document ty usage in the project README
@mjun0812mjun0812 added the enhancement New feature or request label Sep 2, 2026
@mjun0812mjun0812 self-assigned this Sep 2, 2026

@mjun0812mjun0812 left a comment

Copy link
Copy Markdown
OwnerAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codex PR Review

Summary

This pull request adds ty as a locked development dependency, runs type checking in both template verification and generated-project CI, and updates the repository documentation. No blocking findings were confirmed. The Contract axis was skipped because no spec source was available.

Verdict

APPROVE

Findings

N/A


Reviewed by Codex at de8d645

@mjun0812
mjun0812 merged commit fb6a25c into mainSep 3, 2026
6 checks passed
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancementNew feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

@mjun0812