feat: Add ty as a linter

Author: whoahbot

.github/workflows/mirror.yml

@@ -18,6 +18,12 @@ jobs:
           npx @bazel/buildifier lint/ruff_versions.bzl
           cd docs
           bazel run update
+      - name: Update ty
+        run: |
+          ./lint/mirror_ty.sh
+          npx @bazel/buildifier lint/ty_versions.bzl
+          cd docs
+          bazel run update
       - name: Download and Extract Latest Multitool
         run: wget -O- https://github.com/theoremlp/multitool/releases/download/v0.11.0/multitool-x86_64-unknown-linux-gnu.tar.xz | tar --strip-components=1 -xJf -
       - name: Find Updates and Render Lockfile

README.md

@@ -47,7 +47,7 @@ Linters which are not language-specific:
 | Kotlin                 | [ktfmt]                   | [ktlint]                         |
 | Markdown               | [Prettier]                | [Vale]                           |
 | Protocol Buffer        | [buf]                     | [buf lint]                       |
-| Python                 | [ruff]                    | [flake8], [pylint], [ruff]       |
+| Python                 | [ruff]                    | [flake8], [pylint], [ruff], [ty] |
 | Ruby                   |                           | [RuboCop]                        |
 | Rust                   | [rustfmt]                 |                                  |
 | SQL                    | [prettier-plugin-sql]     |                                  |
@@ -86,6 +86,7 @@ Linters which are not language-specific:
 [scalafmt]: https://scalameta.org/scalafmt
 [rubocop]: https://docs.rubocop.org/
 [ruff]: https://docs.astral.sh/ruff/
+[ty]: https://docs.astral.sh/ty/
 [pylint]: https://pylint.readthedocs.io/en/stable/
 [shellcheck]: https://www.shellcheck.net/
 [shfmt]: https://github.com/mvdan/sh

example/BUILD.bazel

@@ -30,6 +30,7 @@ exports_files(
         "ktlint-baseline.xml",
         ".clang-tidy",
         "spotbugs-exclude.xml",
+        "ty.toml",
     ],
     visibility = ["//visibility:public"],
 )

example/lint.sh

@@ -35,9 +35,9 @@ esac
 args=()
 if [ $machine == "Windows" ]; then
 	# avoid missing linters on windows platform
-	args=("--aspects=$(echo //tools/lint:linters.bzl%{flake8,pylint,pmd,ruff,vale,yamllint,clang_tidy} | tr ' ' ',')")
+	args=("--aspects=$(echo //tools/lint:linters.bzl%{flake8,pylint,pmd,ruff,ty,vale,yamllint,clang_tidy} | tr ' ' ',')")
 else
-	args=("--aspects=$(echo //tools/lint:linters.bzl%{buf,eslint,flake8,keep_sorted,ktlint,pmd,pylint,ruff,shellcheck,stylelint,vale,yamllint,clang_tidy,spotbugs} | tr ' ' ',')")
+	args=("--aspects=$(echo //tools/lint:linters.bzl%{buf,eslint,flake8,keep_sorted,ktlint,pmd,pylint,ruff,ty,shellcheck,stylelint,vale,yamllint,clang_tidy,spotbugs} | tr ' ' ',')")
 fi
 
 # NB: perhaps --remote_download_toplevel is needed as well with remote execution?

example/src/BUILD.bazel

@@ -90,6 +90,16 @@ py_library(
     srcs = ["unused_import.py"],
 )
 
+py_library(
+    name = "unsupported_operator",
+    srcs = ["unsupported_operator.py"],
+)
+
+py_library(
+    name = "call_non_callable",
+    srcs = ["call_non_callable.py"],
+)
+
 filegroup(
     name = "unused_import_pyi",
     srcs = ["unused_import.pyi"],

example/src/call_non_callable.py

@@ -0,0 +1,5 @@
+# Demo with just running ty:
+# $ ./lint.sh src:call_non_callable
+B = 1
+# This error should be ignored, as it is specified as ignored in src/ty.toml
+B()

example/src/unsupported_operator.py

@@ -0,0 +1,3 @@
+# Demo with just running ty from the examples dir:
+# $ ./lint.sh src:unsupported_operator
+a = 10 + "test"

example/test/BUILD.bazel

@@ -15,6 +15,7 @@ load(
     "rubocop_test",
     "ruff_test",
     "shellcheck_test",
+    "ty_test",
 )
 
 write_file(
@@ -78,6 +79,11 @@ py_library(
     srcs = ["excluded.py"],
 )
 
+py_library(
+    name = "unsupported_operator",
+    srcs = ["unsupported_operator.py"],
+)
+
 java_library(
     name = "generated_java",
     srcs = ["generated.java"],
@@ -139,6 +145,13 @@ pylint_test(
     tags = ["manual"],
 )
 
+ty_test(
+    name = "ty_should_fail_unsupported_operator",
+    srcs = ["//src:unsupported_operator"],
+    # Expected to fail based on current content of the file.
+    tags = ["manual"],
+)
+
 pmd_test(
     name = "pmd",
     srcs = ["//src:foo"],

example/test/lint_test.bats

@@ -21,6 +21,28 @@ EOF
 src/unused_import.py:15:0: C0301: Line too long (180/120) (line-too-long)
 src/unused_import.py:22:6: W1302: Invalid format string (bad-format-string)
 src/unused_import.py:18:0: W0611: Unused import os (unused-import)
+EOF
+
+	# Ty
+	echo <<"EOF" | assert_output --partial
+error[unsupported-operator]: Operator `+` is unsupported between objects of type `Literal[10]` and `Literal["test"]`
+ --> src/unsupported_operator.py:3:5
+  |
+1 | # Demo with just running ty from the examples dir:
+2 | # $ ./lint.sh src:unsupported_operator
+3 | a = 10 + "test"
+  |     ^^^^^^^^^^^
+  |
+info: rule `unsupported-operator` is enabled by default
+
+Found 1 diagnostic
+EOF
+
+	# pylint
+	echo <<"EOF" | assert_output --partial
+src/unused_import.py:15:0: C0301: Line too long (180/120) (line-too-long)
+src/unused_import.py:22:6: W1302: Invalid format string (bad-format-string)
+src/unused_import.py:18:0: W0611: Unused import os (unused-import)
 EOF
 
 	# Flake8

example/test/machine_outputs/BUILD.bazel

@@ -9,6 +9,7 @@ load(
     "machine_ruff_report",
     "machine_shellcheck_report",
     "machine_stylelint_report",
+    "machine_ty_report",
     "machine_vale_report",
     "machine_yamllint_report",
     "report_test",
@@ -38,6 +39,18 @@ report_test(
     report = "machine_ruff_pyi_report",
 )
 
+machine_ty_report(
+    name = "machine_ty_report",
+    src = "//src:unsupported_operator",
+)
+
+report_test(
+    name = "ty_machine_output_test",
+    expected_tool = "Ty",
+    expected_uri = "src/unsupported_operator.py",
+    report = "machine_ty_report",
+)
+
 machine_shellcheck_report(
     name = "machine_shellcheck_report",
     src = "//src:hello_shell",