Skip to content

feat: Enable GitHub output format for Pyrefly type checker#36205

Closed
xxiaoxiong wants to merge 1 commit into
langgenius:mainfrom
xxiaoxiong:feat/add-github-output-format-36189
Closed

feat: Enable GitHub output format for Pyrefly type checker#36205
xxiaoxiong wants to merge 1 commit into
langgenius:mainfrom
xxiaoxiong:feat/add-github-output-format-36189

Conversation

@xxiaoxiong

Copy link
Copy Markdown
Contributor

Description

This PR enables GitHub-formatted output for the Pyrefly type checker, which will show inline annotations in pull requests for type checking errors.

Changes

  • Added outputformat = "github" to [tool.pyrefly] configuration in api/pyproject.toml

Benefits

  • Better DX: Type errors will appear as inline comments in PR diffs
  • Faster feedback: Developers can see type issues directly in the GitHub UI without checking CI logs
  • Consistent with best practices: Follows Pyrefly's recommended configuration for GitHub Actions

Reference

Testing

The configuration change is minimal and follows Pyrefly's official documentation. The next PR with type checking will demonstrate the inline annotations.

Fixes #36189

Add 'outputformat = "github"' to [tool.pyrefly] configuration to enable
inline PR annotations for type checking errors. This improves developer
experience by showing type errors directly in GitHub PR diffs.

Ref: https://pyrefly.org/en/docs/installation/#inline-pr-annotations

Fixes #36189
@xxiaoxiong xxiaoxiong requested a review from a team May 15, 2026 05:39
@xxiaoxiong xxiaoxiong requested a review from QuantumGhost as a code owner May 15, 2026 05:39
@dosubot dosubot Bot added the size:XS This PR changes 0-9 lines, ignoring generated files. label May 15, 2026
@dosubot dosubot Bot added the lgtm This PR has been approved by a maintainer label May 15, 2026
Comment thread api/pyproject.toml
python-platform = "linux"
python-version = "3.12.0"
infer-with-first-use = false
outputformat = "github"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@dosubot dosubot Bot removed the lgtm This PR has been approved by a maintainer label May 15, 2026
@xxiaoxiong xxiaoxiong closed this May 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size:XS This PR changes 0-9 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Use output format GitHub in type checker

2 participants