(Feat): Add linter: ty #1028

TylerJang27 · 2025-05-14T08:19:46Z

Fixes #1024. https://github.com/astral-sh/ty#readme

gemini-code-assist

Hello @TylerJang27, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

Summary of Changes

This pull request introduces the ty linter to the Trunk toolset. According to the description, ty is a static type checker for Python. The changes include adding ty to the list of supported linters in the README.md file and creating a new plugin configuration file (plugin.yaml) for ty. Additionally, test data and snapshot files are added to ensure the linter functions as expected.

Highlights

Linter Integration: The primary focus is the integration of the ty linter into the Trunk ecosystem, enabling static type checking for Python code.
Configuration File: A plugin.yaml file is created to define the linter's version, download location, and execution commands.
Test Cases: Test cases and snapshot files are added to verify the linter's functionality and ensure consistent output.

Changelog

Click here to see the changelog

README.md
- Added ty to the list of supported Python linters in the table.
- Added a link to the ty linter's repository in the references section.
linters/ty/plugin.yaml
- Created a new plugin configuration file for the ty linter.
- Configured the linter's download location, version, and execution commands.
- Defined health checks to ensure the linter is functioning correctly.
- Configured the linter to run on Python and Python interface files.
linters/ty/test_data/basic.in.py
- Added a basic Python test file for the ty linter.
- The test file includes type annotations and code that should trigger type checking errors.
linters/ty/test_data/interface.in.pyi
- Added a Python interface test file for the ty linter.
- This file tests the linter's ability to check Python interface files (.pyi).
linters/ty/test_data/ty_v0.0.1-alpha.1_basic.check.shot
- Created a snapshot file for the basic Python test case.
- This file contains the expected output of the ty linter when run on the basic test file.
linters/ty/test_data/ty_v0.0.1-alpha.1_interface.check.shot
- Created a snapshot file for the Python interface test case.
- This file contains the expected output of the ty linter when run on the interface test file.
linters/ty/ty.test.ts
- Added a test file to run the ty linter and compare its output to the snapshot files.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature	Command	Description
Code Review	`/gemini review`	Performs a code review for the current pull request in its current state.
Pull Request Summary	`/gemini summary`	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in issue comments and review comments.
Help	`/gemini help`	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

A new linter arrives,
ty checks types with zeal,
Code's safety thrives.

Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

trunk-staging-io · 2025-05-14T08:20:21Z

Code-Quality-on-PRs is deprecated and will soon be removed. Please see the migration guide for more information.

gemini-code-assist

Code Review

This pull request introduces the ty linter to the Trunk toolset, which enhances Python code analysis. The changes include modifications to the README to reflect the addition of ty and the creation of necessary configuration and test files for the linter. Overall, the integration seems well-structured, but there are a few points that could be improved.

Summary of Findings

README.md Linter Alphabetization: The ty linter was added to the README.md file, but it was not alphabetized with the other linters.
plugin.yaml Download Source Descriptions: The download sources in the plugin.yaml file lack descriptions, which can reduce readability and maintainability.
plugin.yaml Suggest If Field: The suggest_if: never field in plugin.yaml lacks a comment explaining why Trunk should never suggest enabling this linter.
Test File Descriptions: The test files lack descriptions, which can make it difficult to understand their purpose and what aspects of the linter they are designed to test.
Snapshot Issues: The snapshots contain several issues related to missing imports and definitions, which can reduce the accuracy of the tests.

Merge Readiness

The pull request introduces the ty linter to the Trunk toolset. While the integration appears well-structured, there are several issues that need to be addressed before merging. Specifically, the linter alphabetization in the README.md file, the download source descriptions in the plugin.yaml file, the suggest_if field in the plugin.yaml file, the test file descriptions, and the snapshot issues. I am unable to approve this pull request, and recommend that it not be merged until these issues are addressed.

gemini-code-assist · 2025-05-14T08:20:26Z

README.md

+| PowerShell      | [psscriptanalyzer]                                                                                                         |
+| Prisma          | [prisma]                                                                                                                   |
+| Protobuf        | [buf] (breaking, lint, and format), [clang-format], [clang-tidy]                                                           |
+| Python          | [autopep8], [bandit], [black], [flake8], [isort], [mypy], [pylint], [pyright], [semgrep], [yapf], [ruff], [sourcery], [ty] |


It appears that sourcery is also a linter, so it should be alphabetized with the other linters. Can you please move ty to the correct alphabetical position?

gemini-code-assist · 2025-05-14T08:20:26Z

linters/ty/plugin.yaml

+      files: [python, python-interface]
+      tools: [ty]
+      known_good_version: 0.0.1-alpha.1
+      suggest_if: never


The suggest_if: never field indicates that Trunk should never suggest enabling this linter. Is this intentional? If so, please add a comment explaining why.

gemini-code-assist · 2025-05-14T08:20:26Z

linters/ty/test_data/ty_v0.0.1-alpha.1_basic.check.shot

+      "file": "test_data/basic.in.py",
+      "issueClass": "ISSUE_CLASS_EXISTING",
+      "level": "LEVEL_HIGH",
+      "line": "5",
+      "linter": "ty",
+      "message": "Return type does not match returned value: Expected \`str\`, found \`int\`",
+      "targetType": "python",
+    },
+    {
+      "code": "revealed-type",
+      "column": "1",
+      "file": "test_data/basic.in.py",
+      "issueClass": "ISSUE_CLASS_EXISTING",
+      "level": "LEVEL_LOW",
+      "line": "50",
+      "linter": "ty",
+      "message": "Revealed type: \`int | None\`",
+      "targetType": "python",
+    },
+    {
+      "code": "undefined-reveal",
+      "column": "1",
+      "file": "test_data/basic.in.py",
+      "issueClass": "ISSUE_CLASS_EXISTING",
+      "level": "LEVEL_MEDIUM",
+      "line": "50",
+      "linter": "ty",
+      "message": "\`reveal_type\` used without importing it",
+      "targetType": "python",
+    },
+    {
+      "code": "unsupported-operator",
+      "column": "1",
+      "file": "test_data/basic.in.py",
+      "issueClass": "ISSUE_CLASS_EXISTING",
+      "level": "LEVEL_HIGH",
+      "line": "51",
+      "linter": "ty",
+      "message": "Operator \`+\` is unsupported between objects of type \`int | None\` and \`Literal[1]\`",
+      "targetType": "python",
+    },
+    {
+      "code": "revealed-type",
+      "column": "1",
+      "file": "test_data/basic.in.py",
+      "issueClass": "ISSUE_CLASS_EXISTING",
+      "level": "LEVEL_LOW",
+      "line": "53",
+      "linter": "ty",
+      "message": "Revealed type: \`int | None\`",
+      "targetType": "python",
+    },
+    {
+      "code": "undefined-reveal",
+      "column": "1",
+      "file": "test_data/basic.in.py",
+      "issueClass": "ISSUE_CLASS_EXISTING",
+      "level": "LEVEL_MEDIUM",
+      "line": "53",
+      "linter": "ty",
+      "message": "\`reveal_type\` used without importing it",
+      "targetType": "python",
+    },
+    {
+      "code": "unsupported-operator",
+      "column": "1",
+      "file": "test_data/basic.in.py",
+      "issueClass": "ISSUE_CLASS_EXISTING",
+      "level": "LEVEL_HIGH",
+      "line": "53",
+      "linter": "ty",
+      "message": "Operator \`+\` is unsupported between objects of type \`int | None\` and \`Literal[1]\`",
+      "targetType": "python",
+    },
+  ],
+  "lintActions": [
+    {
+      "command": "check",
+      "fileGroupName": "python",
+      "linter": "ty",
+      "paths": [
+        "test_data/basic.in.py",
+      ],
+      "verb": "TRUNK_VERB_CHECK",
+    },
+    {
+      "command": "check",
+      "fileGroupName": "python",
+      "linter": "ty",
+      "paths": [
+        "test_data/basic.in.py",
+      ],
+      "upstream": true,
+      "verb": "TRUNK_VERB_CHECK",
+    },
+  ],
+  "taskFailures": [],
+  "unformattedFiles": [],
+}
+`;


The snapshot contains several issues related to reveal_type not being imported. Consider adding the necessary import statement to the test file to resolve these issues and improve the accuracy of the test.

gemini-code-assist · 2025-05-14T08:20:26Z

linters/ty/test_data/ty_v0.0.1-alpha.1_interface.check.shot

+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`Testing linter ty test interface 1`] = `
+{
+  "issues": [
+    {
+      "code": "unresolved-reference",
+      "column": "1",
+      "file": "test_data/interface.in.pyi",
+      "issueClass": "ISSUE_CLASS_EXISTING",
+      "level": "LEVEL_HIGH",
+      "line": "11",
+      "linter": "ty",
+      "message": "Name \`overload\` used when not defined",
+      "targetType": "python-interface",
+    },
+    {
+      "code": "unresolved-reference",
+      "column": "1",
+      "file": "test_data/interface.in.pyi",
+      "issueClass": "ISSUE_CLASS_EXISTING",
+      "level": "LEVEL_HIGH",
+      "line": "14",
+      "linter": "ty",
+      "message": "Name \`overload\` used when not defined",
+      "targetType": "python-interface",
+    },
+    {
+      "code": "unresolved-reference",
+      "column": "1",
+      "file": "test_data/interface.in.pyi",
+      "issueClass": "ISSUE_CLASS_EXISTING",
+      "level": "LEVEL_HIGH",
+      "line": "31",
+      "linter": "ty",
+      "message": "Name \`decorated\` used when not defined",
+      "targetType": "python-interface",
+    },
+  ],
+  "lintActions": [
+    {
+      "command": "check",
+      "fileGroupName": "python-interface",
+      "linter": "ty",
+      "paths": [
+        "test_data/interface.in.pyi",
+      ],
+      "verb": "TRUNK_VERB_CHECK",
+    },
+    {
+      "command": "check",
+      "fileGroupName": "python-interface",
+      "linter": "ty",
+      "paths": [
+        "test_data/interface.in.pyi",
+      ],
+      "upstream": true,
+      "verb": "TRUNK_VERB_CHECK",
+    },
+  ],
+  "taskFailures": [],
+  "unformattedFiles": [],
+}
+`;


The snapshot contains several unresolved-reference issues. Consider adding the necessary definitions or imports to the test file to resolve these issues and improve the accuracy of the test.

trunk-staging-io · 2025-05-14T08:39:12Z

_{View Full Report ↗︎ ⋅ Docs}

trunk-io · 2025-05-14T08:48:27Z

_{View Full Report ↗︎ ⋅ Docs}

TylerJang27 · 2025-05-14T19:44:29Z

It's possible this may need some pyright-like configuration

implement ty linter

0a58216

gemini-code-assist bot reviewed May 14, 2025

View reviewed changes

gemini-code-assist bot suggested changes May 14, 2025

View reviewed changes

description

ce1f861

TylerJang27 requested review from det, pat-trunk-io and puzzler7 May 14, 2025 19:44

puzzler7 approved these changes May 15, 2025

View reviewed changes

TylerJang27 merged commit 8ad7d13 into main May 15, 2025
14 checks passed

TylerJang27 deleted the tyler/ty branch May 15, 2025 16:55

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

(Feat): Add linter: ty #1028

(Feat): Add linter: ty #1028

Uh oh!

TylerJang27 commented May 14, 2025 •

edited

Loading

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

trunk-staging-io bot commented May 14, 2025

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

gemini-code-assist bot May 14, 2025

Uh oh!

gemini-code-assist bot May 14, 2025

Uh oh!

gemini-code-assist bot May 14, 2025

Uh oh!

gemini-code-assist bot May 14, 2025

Uh oh!

trunk-staging-io bot commented May 14, 2025 •

edited

Loading

Uh oh!

trunk-io bot commented May 14, 2025 •

edited

Loading

Uh oh!

TylerJang27 commented May 14, 2025

Uh oh!

Uh oh!

Uh oh!

(Feat): Add linter: ty #1028

(Feat): Add linter: ty #1028

Uh oh!

Conversation

TylerJang27 commented May 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Summary of Changes

Highlights

Changelog

Footnotes

Uh oh!

trunk-staging-io bot commented May 14, 2025

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Summary of Findings

Merge Readiness

Uh oh!

gemini-code-assist bot May 14, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot May 14, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot May 14, 2025

Choose a reason for hiding this comment

Uh oh!

gemini-code-assist bot May 14, 2025

Choose a reason for hiding this comment

Uh oh!

trunk-staging-io bot commented May 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

trunk-io bot commented May 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TylerJang27 commented May 14, 2025

Uh oh!

Uh oh!

Uh oh!

TylerJang27 commented May 14, 2025 •

edited

Loading

trunk-staging-io bot commented May 14, 2025 •

edited

Loading

trunk-io bot commented May 14, 2025 •

edited

Loading