diff --git a/linters/actionlint/plugin.yaml b/linters/actionlint/plugin.yaml index 4b2c0a170..54eae807a 100644 --- a/linters/actionlint/plugin.yaml +++ b/linters/actionlint/plugin.yaml @@ -29,6 +29,7 @@ lint: files: [github-workflow] # Custom parser/trigger type defined in the trunk cli. tools: [actionlint] + description: Verify your Github workflows commands: - name: lint output: actionlint diff --git a/linters/ansible-lint/plugin.yaml b/linters/ansible-lint/plugin.yaml index bcb557669..ca71524ac 100644 --- a/linters/ansible-lint/plugin.yaml +++ b/linters/ansible-lint/plugin.yaml @@ -14,6 +14,7 @@ lint: supported_platforms: [linux, macos] # No files as this linter must be triggered manually. files: [] + description: Improve ansible playbooks commands: - name: lint version: ">=6.1.0" diff --git a/linters/autopep8/plugin.yaml b/linters/autopep8/plugin.yaml index 97bcffcbd..2ea2c6e61 100644 --- a/linters/autopep8/plugin.yaml +++ b/linters/autopep8/plugin.yaml @@ -11,6 +11,7 @@ lint: definitions: - name: autopep8 files: [python] + description: A python formatter commands: - name: format output: rewrite diff --git a/linters/bandit/plugin.yaml b/linters/bandit/plugin.yaml index 16ec14d7b..81a660d66 100644 --- a/linters/bandit/plugin.yaml +++ b/linters/bandit/plugin.yaml @@ -13,6 +13,7 @@ lint: tools: [bandit] suggest_if: files_present direct_configs: [.bandit] + description: A security linter for Python commands: - name: lint # Custom parser type defined in the trunk cli to handle bandit's JSON output. diff --git a/linters/biome/plugin.yaml b/linters/biome/plugin.yaml index 776da91cf..5a7410168 100644 --- a/linters/biome/plugin.yaml +++ b/linters/biome/plugin.yaml @@ -15,6 +15,7 @@ lint: - typescript - javascript - json + description: A static analyzer for web projects commands: - name: lint output: regex diff --git a/linters/black/plugin.yaml b/linters/black/plugin.yaml index 698e4b163..329fb2db1 100644 --- a/linters/black/plugin.yaml +++ b/linters/black/plugin.yaml @@ -10,6 +10,7 @@ lint: definitions: - name: black files: [python, jupyter, python-interface] + description: Uncompromising python formatter commands: - name: format output: rewrite diff --git a/linters/brakeman/plugin.yaml b/linters/brakeman/plugin.yaml index 452fb1eb4..ec97780f8 100644 --- a/linters/brakeman/plugin.yaml +++ b/linters/brakeman/plugin.yaml @@ -10,6 +10,7 @@ lint: definitions: - name: brakeman files: [ruby] + description: A vulnerability scanner for Ruby commands: - name: lint # 5.0.0 introduced the sarif output format. diff --git a/linters/buf/plugin.yaml b/linters/buf/plugin.yaml index 492c2320d..813a3d97b 100644 --- a/linters/buf/plugin.yaml +++ b/linters/buf/plugin.yaml @@ -32,6 +32,7 @@ lint: files: [proto] download: buf suggest_if: never + description: Formatter for Protobuf commands: - name: format output: rewrite @@ -62,6 +63,7 @@ lint: - name: buf-lint files: [proto] download: buf + description: Accelerate Protobuf development with Buf commands: - name: lint output: buf @@ -90,6 +92,7 @@ lint: files: [proto] download: buf suggest_if: never + description: Check for breaking Protobuf API changes commands: - name: lint output: buf diff --git a/linters/buildifier/plugin.yaml b/linters/buildifier/plugin.yaml index 897faa943..ddfb2f793 100644 --- a/linters/buildifier/plugin.yaml +++ b/linters/buildifier/plugin.yaml @@ -43,6 +43,7 @@ lint: - name: buildifier files: [starlark, bazel-build, bazel-workspace] tools: [buildifier] + description: Formatter for Bazel files commands: - name: fix run: buildifier --lint=fix --warnings=all "${target}" diff --git a/linters/cfnlint/plugin.yaml b/linters/cfnlint/plugin.yaml index 5def28df7..0d2a2d4f5 100644 --- a/linters/cfnlint/plugin.yaml +++ b/linters/cfnlint/plugin.yaml @@ -10,6 +10,7 @@ lint: definitions: - name: cfnlint files: [cloudformation] + description: Checks Cloudformation files commands: - name: lint # Custom parser type defined in the trunk cli to handle cfnlint's JSON output and triggers. diff --git a/linters/checkov/plugin.yaml b/linters/checkov/plugin.yaml index eadb751de..62c18cd7f 100644 --- a/linters/checkov/plugin.yaml +++ b/linters/checkov/plugin.yaml @@ -11,6 +11,7 @@ lint: - name: checkov files: [terraform, cloudformation, docker, yaml, json] tools: [checkov] + description: Finds security issues in IaC files commands: - name: lint # on Windows, we need to make sure 'checkov' resolves to 'checkov.cmd' diff --git a/linters/circleci/plugin.yaml b/linters/circleci/plugin.yaml index 3b568aa73..4743e450c 100644 --- a/linters/circleci/plugin.yaml +++ b/linters/circleci/plugin.yaml @@ -11,6 +11,7 @@ lint: tools: [circleci] known_good_version: 0.1.28811 suggest_if: never + description: Validates CircleCI configuration files commands: - name: validate platforms: [windows] diff --git a/linters/clang-format/plugin.yaml b/linters/clang-format/plugin.yaml index a874492fc..518a4fa3d 100644 --- a/linters/clang-format/plugin.yaml +++ b/linters/clang-format/plugin.yaml @@ -33,6 +33,7 @@ lint: definitions: - name: clang-format supported_platforms: [linux, macos] + description: Formatter for C/C++ and Protobuf files: [c/c++, cuda, proto] commands: - name: format diff --git a/linters/clang-tidy/plugin.yaml b/linters/clang-tidy/plugin.yaml index 65535d29f..80ac4e5e1 100644 --- a/linters/clang-tidy/plugin.yaml +++ b/linters/clang-tidy/plugin.yaml @@ -34,6 +34,7 @@ lint: - name: clang-tidy supported_platforms: [linux, macos] files: [c/c++-source] + description: Static Analyzer for C/C++ commands: - name: lint output: llvm diff --git a/linters/clippy/plugin.yaml b/linters/clippy/plugin.yaml index e1ee7469a..705fe9179 100644 --- a/linters/clippy/plugin.yaml +++ b/linters/clippy/plugin.yaml @@ -9,6 +9,7 @@ lint: - name: clippy files: [rust] download: rust + description: Catch common mistakes and improve your Rust code. commands: - name: lint # Custom parser type defined in the trunk cli to handle clippy's JSON output. diff --git a/linters/cmake-format/plugin.yaml b/linters/cmake-format/plugin.yaml index b7775bab8..0f420e744 100644 --- a/linters/cmake-format/plugin.yaml +++ b/linters/cmake-format/plugin.yaml @@ -10,6 +10,7 @@ lint: definitions: - name: cmake-format files: [cmake] + description: A formatter for cmake files commands: - name: fix formatter: true diff --git a/linters/codespell/plugin.yaml b/linters/codespell/plugin.yaml index 178e9e27c..6aca0b572 100644 --- a/linters/codespell/plugin.yaml +++ b/linters/codespell/plugin.yaml @@ -12,6 +12,7 @@ lint: files: [ALL] direct_configs: [.codespellrc] suggest_if: config_present + description: Check for common misspellings in your code affects_cache: - pyproject.toml - setup.cfg diff --git a/linters/cspell/plugin.yaml b/linters/cspell/plugin.yaml index e4e9737e0..7c39aef41 100644 --- a/linters/cspell/plugin.yaml +++ b/linters/cspell/plugin.yaml @@ -11,6 +11,7 @@ lint: - name: cspell files: [ALL] tools: [cspell] + description: Check for spelling mistakes in your code commands: - name: lint output: regex diff --git a/linters/cue-fmt/plugin.yaml b/linters/cue-fmt/plugin.yaml index 0d37ba982..bcb8b4933 100644 --- a/linters/cue-fmt/plugin.yaml +++ b/linters/cue-fmt/plugin.yaml @@ -10,6 +10,7 @@ lint: definitions: - name: cue-fmt files: [cue] + description: A formatter for cue files commands: - name: format output: rewrite diff --git a/linters/dart/plugin.yaml b/linters/dart/plugin.yaml index 638db74f0..425990988 100644 --- a/linters/dart/plugin.yaml +++ b/linters/dart/plugin.yaml @@ -30,6 +30,7 @@ lint: files: [dart] known_good_version: 3.2.6 suggest_if: never + description: Lints and formats dart code affects_cache: - analysis_options.yaml - pubspec.yaml diff --git a/linters/deno/plugin.yaml b/linters/deno/plugin.yaml index 045a242c1..e94447cba 100644 --- a/linters/deno/plugin.yaml +++ b/linters/deno/plugin.yaml @@ -3,6 +3,7 @@ lint: definitions: - name: deno files: [javascript, typescript, markdown, json] + description: A formatter for web framework code commands: - name: format output: rewrite diff --git a/linters/detekt/plugin.yaml b/linters/detekt/plugin.yaml index 1e135aa5c..a4d4dc911 100644 --- a/linters/detekt/plugin.yaml +++ b/linters/detekt/plugin.yaml @@ -11,6 +11,7 @@ lint: - name: detekt files: [kotlin] download: detekt + description: Static code analysis for Kotlin commands: - name: lint platforms: [windows] @@ -45,6 +46,7 @@ lint: - name: detekt-explicit files: [kotlin] download: detekt + description: Static code analysis for Kotlin commands: - name: lint platforms: [windows] @@ -75,6 +77,7 @@ lint: - name: detekt-gradle supported_platforms: [linux, macos] files: [kotlin] + description: Static code analysis for Kotlin commands: - name: lint # Custom parser/trigger type defined in the trunk cli. diff --git a/linters/djlint/plugin.yaml b/linters/djlint/plugin.yaml index 5d9552c6c..3de172114 100644 --- a/linters/djlint/plugin.yaml +++ b/linters/djlint/plugin.yaml @@ -11,6 +11,7 @@ lint: - name: djlint files: [html] tools: [djlint] + description: HTML template linter and formatter commands: - name: lint output: regex diff --git a/linters/dotenv-linter/plugin.yaml b/linters/dotenv-linter/plugin.yaml index 0fe0b9116..cf8d04dec 100644 --- a/linters/dotenv-linter/plugin.yaml +++ b/linters/dotenv-linter/plugin.yaml @@ -33,6 +33,7 @@ lint: - name: dotenv-linter files: [dotenv] tools: [dotenv-linter] + description: Lightning-fast linter for .env files commands: - name: format output: rewrite diff --git a/linters/dotnet-format/plugin.yaml b/linters/dotnet-format/plugin.yaml index 9d9adb72a..789e8a39e 100644 --- a/linters/dotnet-format/plugin.yaml +++ b/linters/dotnet-format/plugin.yaml @@ -9,6 +9,7 @@ lint: # https://download.visualstudio.microsoft.com/download/pr/0f17575a-a6b0-4365-9b79-64db70022d23/56e0da10678e4b2cad0cba0a83a561af/dotnet-sdk-7.0.400-win-x86.zip, # but we don't support that yet. known_good_version: 7.0.400 + description: A formatter for dotnet files commands: - name: format run: dotnet format --no-restore --include ${target} diff --git a/linters/dustilock/plugin.yaml b/linters/dustilock/plugin.yaml index 8531043b4..6592c0a6d 100644 --- a/linters/dustilock/plugin.yaml +++ b/linters/dustilock/plugin.yaml @@ -11,6 +11,7 @@ lint: - name: dustilock files: [dustilock] tools: [dustilock] + description: Finds security issues in dustilock files commands: - name: scan output: regex diff --git a/linters/eslint/plugin.yaml b/linters/eslint/plugin.yaml index 29e21bc3f..1562bcb3a 100644 --- a/linters/eslint/plugin.yaml +++ b/linters/eslint/plugin.yaml @@ -11,6 +11,7 @@ lint: - name: eslint files: [typescript, javascript] tools: [eslint] + description: Find and fix problems in your TS/JS code commands: - name: lint output: eslint diff --git a/linters/flake8/plugin.yaml b/linters/flake8/plugin.yaml index bfcaffd4b..0a21e615f 100644 --- a/linters/flake8/plugin.yaml +++ b/linters/flake8/plugin.yaml @@ -10,6 +10,7 @@ lint: definitions: - name: flake8 files: [python] + description: Python style guide enforcement commands: - name: lint run: flake8 ${target} --output-file "${tmpfile}" --exit-zero diff --git a/linters/git-diff-check/plugin.yaml b/linters/git-diff-check/plugin.yaml index 64e325d9d..25d98a1be 100644 --- a/linters/git-diff-check/plugin.yaml +++ b/linters/git-diff-check/plugin.yaml @@ -3,6 +3,7 @@ lint: definitions: - name: git-diff-check files: [ALL] + description: Checks for git conflicts commands: - output: regex name: lint diff --git a/linters/gitleaks/plugin.yaml b/linters/gitleaks/plugin.yaml index 61bef5fa2..d8b2b0753 100644 --- a/linters/gitleaks/plugin.yaml +++ b/linters/gitleaks/plugin.yaml @@ -10,6 +10,7 @@ lint: definitions: - name: gitleaks files: [ALL] + description: Protect and discover secrets commands: - name: lint run: gitleaks detect --no-git --source=${target} --exit-code=101 -f sarif -r "${tmpfile}" diff --git a/linters/gofmt/plugin.yaml b/linters/gofmt/plugin.yaml index 59c1b15c6..573be13a1 100644 --- a/linters/gofmt/plugin.yaml +++ b/linters/gofmt/plugin.yaml @@ -3,6 +3,7 @@ lint: definitions: - name: gofmt files: [go] + description: A formatter for Go code commands: - name: format output: rewrite diff --git a/linters/gofumpt/plugin.yaml b/linters/gofumpt/plugin.yaml index b5be10e46..f013fa267 100644 --- a/linters/gofumpt/plugin.yaml +++ b/linters/gofumpt/plugin.yaml @@ -11,6 +11,7 @@ lint: - name: gofumpt tools: [gofumpt] files: [go] + description: An opinionated formatter for Go code commands: - name: format output: rewrite diff --git a/linters/goimports/plugin.yaml b/linters/goimports/plugin.yaml index 6fee30c74..8a39c5e02 100644 --- a/linters/goimports/plugin.yaml +++ b/linters/goimports/plugin.yaml @@ -10,6 +10,7 @@ lint: definitions: - name: goimports files: [go] + description: Removes unused imports from Go code commands: - name: format output: rewrite diff --git a/linters/gokart/plugin.yaml b/linters/gokart/plugin.yaml index 07ea8bc6b..59468e821 100644 --- a/linters/gokart/plugin.yaml +++ b/linters/gokart/plugin.yaml @@ -12,6 +12,7 @@ lint: files: [go] tools: [gokart] suggest_if: config_present + description: Checks for security issues in Go code. environment: - name: PATH list: ["${linter}"] diff --git a/linters/golangci-lint/plugin.yaml b/linters/golangci-lint/plugin.yaml index 8fd02ba83..a67f80d6c 100644 --- a/linters/golangci-lint/plugin.yaml +++ b/linters/golangci-lint/plugin.yaml @@ -13,6 +13,7 @@ lint: - name: golangci-lint files: [go] tools: [golangci-lint] + description: A powerful Go linter runner environment: - name: GOLANGCI_LINT_CACHE value: ${cachedir} diff --git a/linters/golines/plugin.yaml b/linters/golines/plugin.yaml index 5070024da..1c087ce2d 100644 --- a/linters/golines/plugin.yaml +++ b/linters/golines/plugin.yaml @@ -11,6 +11,7 @@ lint: - name: golines files: [go] tools: [golines] + description: Enforces line limits in Go commands: - name: format output: rewrite diff --git a/linters/google-java-format/plugin.yaml b/linters/google-java-format/plugin.yaml index b9902fad4..ca27a5e26 100644 --- a/linters/google-java-format/plugin.yaml +++ b/linters/google-java-format/plugin.yaml @@ -9,6 +9,7 @@ lint: - name: google-java-format files: [java] download: google-java-format.jar + description: A formatter for Java files commands: - name: format platforms: [windows] diff --git a/linters/graphql-schema-linter/plugin.yaml b/linters/graphql-schema-linter/plugin.yaml index 624dc3f56..32fee08b8 100644 --- a/linters/graphql-schema-linter/plugin.yaml +++ b/linters/graphql-schema-linter/plugin.yaml @@ -14,6 +14,7 @@ lint: tools: [graphql-schema-linter] known_good_version: 3.0.1 files: [graphql-schema] + description: Validate GraphQL Schema definitions commands: - name: lint # on Windows, we need to make sure the binary resolves to the cmd form diff --git a/linters/hadolint/plugin.yaml b/linters/hadolint/plugin.yaml index b13fe7340..e462ac52e 100644 --- a/linters/hadolint/plugin.yaml +++ b/linters/hadolint/plugin.yaml @@ -31,6 +31,7 @@ lint: - name: hadolint files: [docker] tools: [hadolint] + description: Helps you build best practice Docker images commands: - name: lint # Custom parser type defined in the trunk cli to handle hadolint's JSON output. diff --git a/linters/haml-lint/plugin.yaml b/linters/haml-lint/plugin.yaml index 213f94d2d..175ee9b7f 100644 --- a/linters/haml-lint/plugin.yaml +++ b/linters/haml-lint/plugin.yaml @@ -10,6 +10,7 @@ lint: definitions: - name: haml-lint files: [haml] + description: Keeps HAML files clean and readable commands: - name: lint # Custom parser type defined in the trunk cli to handle haml_lint's JSON output. diff --git a/linters/isort/plugin.yaml b/linters/isort/plugin.yaml index 26d8a9e1e..a630862ba 100644 --- a/linters/isort/plugin.yaml +++ b/linters/isort/plugin.yaml @@ -10,6 +10,7 @@ lint: definitions: - name: isort files: [python] + description: Sorts your Python imports commands: - name: format output: rewrite diff --git a/linters/iwyu/plugin.yaml b/linters/iwyu/plugin.yaml index ffa837a27..383de6554 100644 --- a/linters/iwyu/plugin.yaml +++ b/linters/iwyu/plugin.yaml @@ -30,6 +30,7 @@ lint: - name: include-what-you-use files: [c/c++-source] tools: [include-what-you-use] + description: Removes unused includes from C/C++ code. commands: - name: lint run_from: ${compile_command} diff --git a/linters/ktlint/plugin.yaml b/linters/ktlint/plugin.yaml index 0d4711dcd..371398932 100644 --- a/linters/ktlint/plugin.yaml +++ b/linters/ktlint/plugin.yaml @@ -12,6 +12,7 @@ lint: files: [kotlin] download: ktlint runtime: java + description: An anti-bikeshedding Kotlin linter and formatter commands: - name: format platforms: [windows] diff --git a/linters/kube-linter/plugin.yaml b/linters/kube-linter/plugin.yaml index 1a6b3c81b..d040b35fc 100644 --- a/linters/kube-linter/plugin.yaml +++ b/linters/kube-linter/plugin.yaml @@ -10,6 +10,7 @@ lint: definitions: - name: kube-linter tools: [kube-linter] + description: A static analyzer for Kubernetes files: - yaml commands: diff --git a/linters/markdown-link-check/plugin.yaml b/linters/markdown-link-check/plugin.yaml index 57507bd01..06263a2df 100644 --- a/linters/markdown-link-check/plugin.yaml +++ b/linters/markdown-link-check/plugin.yaml @@ -11,6 +11,7 @@ lint: - name: markdown-link-check files: [markdown] tools: [markdown-link-check] + description: Checks markdown files for broken links commands: - name: lint # Custom parser type defined in the trunk cli to handle markdownlint's JSON output. diff --git a/linters/markdown-table-prettify/plugin.yaml b/linters/markdown-table-prettify/plugin.yaml index 415ac73f8..a380b0a6b 100644 --- a/linters/markdown-table-prettify/plugin.yaml +++ b/linters/markdown-table-prettify/plugin.yaml @@ -9,6 +9,7 @@ tools: lint: definitions: - name: markdown-table-prettify + description: Prettify markdown tables files: [markdown] main_tool: markdown-table-prettify known_good_version: 3.6.0 diff --git a/linters/markdownlint/plugin.yaml b/linters/markdownlint/plugin.yaml index 4de8b135c..978bbdd0c 100644 --- a/linters/markdownlint/plugin.yaml +++ b/linters/markdownlint/plugin.yaml @@ -11,6 +11,7 @@ lint: - name: markdownlint files: [markdown] tools: [markdownlint] + description: A style checker and lint tool for markdown files commands: - name: lint # Custom parser type defined in the trunk cli to handle markdownlint's JSON output. diff --git a/linters/mypy/plugin.yaml b/linters/mypy/plugin.yaml index db319f832..e301908b2 100644 --- a/linters/mypy/plugin.yaml +++ b/linters/mypy/plugin.yaml @@ -9,6 +9,7 @@ tools: lint: definitions: - name: mypy + description: Static type checker for Python files: [python, python-interface] commands: - name: lint diff --git a/linters/nancy/plugin.yaml b/linters/nancy/plugin.yaml index f212c2e74..0b16031a4 100644 --- a/linters/nancy/plugin.yaml +++ b/linters/nancy/plugin.yaml @@ -21,6 +21,7 @@ lint: files: [go-lockfile] download: nancy runtime: go + description: Checks for vulnerabilities in your Go dependencies commands: - output: sarif run: sh ${plugin}/linters/nancy/run.sh diff --git a/linters/nixpkgs-fmt/plugin.yaml b/linters/nixpkgs-fmt/plugin.yaml index 6749db7ae..b5536eadf 100644 --- a/linters/nixpkgs-fmt/plugin.yaml +++ b/linters/nixpkgs-fmt/plugin.yaml @@ -6,6 +6,7 @@ lint: package: nixpkgs-fmt runtime: rust files: [nix] + description: Formatter for Nix commands: - output: rewrite run: nixpkgs-fmt ${target} diff --git a/linters/opa/plugin.yaml b/linters/opa/plugin.yaml index 56677076d..50380473e 100644 --- a/linters/opa/plugin.yaml +++ b/linters/opa/plugin.yaml @@ -27,6 +27,7 @@ lint: files: [rego] main_tool: opa known_good_version: 0.62.1 + description: Formatter for OPA files suggest_if: never commands: # TODO(Tyler): Add support for opa check command. diff --git a/linters/osv-scanner/plugin.yaml b/linters/osv-scanner/plugin.yaml index 1a414a095..66847e8f6 100644 --- a/linters/osv-scanner/plugin.yaml +++ b/linters/osv-scanner/plugin.yaml @@ -42,6 +42,7 @@ lint: files: [lockfile] tools: [osv-scanner] known_good_version: 1.3.6 + description: Checks for known vulnerabilities in your dependencies commands: - name: scan output: sarif diff --git a/linters/oxipng/plugin.yaml b/linters/oxipng/plugin.yaml index 37fd0ac50..06d173bcd 100644 --- a/linters/oxipng/plugin.yaml +++ b/linters/oxipng/plugin.yaml @@ -23,6 +23,7 @@ lint: - name: oxipng files: [png] download: oxipng + description: Optimize PNG images commands: - name: fmt output: rewrite diff --git a/linters/perlcritic/plugin.yaml b/linters/perlcritic/plugin.yaml index 2599f92cf..ec478155e 100644 --- a/linters/perlcritic/plugin.yaml +++ b/linters/perlcritic/plugin.yaml @@ -3,6 +3,7 @@ lint: definitions: - name: perlcritic supported_platforms: [linux, macos] + description: Static analysis tool for Perl commands: - output: regex success_codes: diff --git a/linters/perltidy/plugin.yaml b/linters/perltidy/plugin.yaml index d5ddf7053..bdbd6f331 100644 --- a/linters/perltidy/plugin.yaml +++ b/linters/perltidy/plugin.yaml @@ -3,6 +3,7 @@ lint: definitions: - name: perltidy supported_platforms: [linux, macos] + description: Formatter for Perl commands: - output: rewrite success_codes: diff --git a/linters/phpstan/plugin.yaml b/linters/phpstan/plugin.yaml index 289e2b61e..e2f117e2a 100644 --- a/linters/phpstan/plugin.yaml +++ b/linters/phpstan/plugin.yaml @@ -14,6 +14,7 @@ lint: - name: phpstan main_tool: phpstan known_good_version: 1.10.58 + description: PHP Static Analysis Tool commands: - run: phpstan analyze "${target}" --error-format=json --level=9 output: sarif diff --git a/linters/pmd/plugin.yaml b/linters/pmd/plugin.yaml index e85573203..64ca2214b 100644 --- a/linters/pmd/plugin.yaml +++ b/linters/pmd/plugin.yaml @@ -13,6 +13,7 @@ lint: definitions: - name: pmd download: pmd + description: Static code analysis for Java and Apex commands: - name: lint-apex version: ">=7.0.0" diff --git a/linters/pragma-once/plugin.yaml b/linters/pragma-once/plugin.yaml index 249af1a37..b4e65c0c5 100644 --- a/linters/pragma-once/plugin.yaml +++ b/linters/pragma-once/plugin.yaml @@ -4,6 +4,7 @@ lint: # Inserts "#pragma once" if it wasn't there - name: pragma-once files: [c-header, c++-header] + description: Enforces "#pragma once" in header files commands: - name: format platforms: [windows] diff --git a/linters/pre-commit-hooks/plugin.yaml b/linters/pre-commit-hooks/plugin.yaml index 1dcc86fd7..49b60027c 100644 --- a/linters/pre-commit-hooks/plugin.yaml +++ b/linters/pre-commit-hooks/plugin.yaml @@ -5,6 +5,7 @@ lint: known_good_version: 4.4.0 runtime: python package: pre-commit-hooks + description: A collection of pre-commit tools for Python suggest_if: never environment: - name: PATH diff --git a/linters/prettier/plugin.yaml b/linters/prettier/plugin.yaml index 452e13f57..f01f16da8 100644 --- a/linters/prettier/plugin.yaml +++ b/linters/prettier/plugin.yaml @@ -21,6 +21,7 @@ lint: - javascript - graphql - prettier_supported_configs + description: A universal formatter commands: - name: format output: sarif diff --git a/linters/prisma/plugin.yaml b/linters/prisma/plugin.yaml index 1aceb385f..1b1ee5a48 100644 --- a/linters/prisma/plugin.yaml +++ b/linters/prisma/plugin.yaml @@ -6,6 +6,7 @@ lint: files: [prisma] known_good_version: 4.16.1 suggest_if: never + description: A Prisma formatter commands: - name: format platforms: [windows] diff --git a/linters/psscriptanalyzer/plugin.yaml b/linters/psscriptanalyzer/plugin.yaml index 3b47d1091..712730a33 100644 --- a/linters/psscriptanalyzer/plugin.yaml +++ b/linters/psscriptanalyzer/plugin.yaml @@ -30,6 +30,7 @@ lint: files: [powershell] main_tool: psscriptanalyzer tools: [converttosarif, pwsh] + description: Linter for PowerShell scripts commands: - name: Invoke-ScriptAnalyzer run: pwsh -f ${cwd}/lint.ps1 -FilePath ${target} -OutputPath ${tmpfile} diff --git a/linters/pylint/plugin.yaml b/linters/pylint/plugin.yaml index fa6163105..def3cfe4b 100644 --- a/linters/pylint/plugin.yaml +++ b/linters/pylint/plugin.yaml @@ -10,6 +10,7 @@ lint: definitions: - name: pylint files: [python] + description: Static code analysis for Python commands: - name: lint # Custom parser type defined in the trunk cli to handle pylint's JSON output. diff --git a/linters/pyright/plugin.yaml b/linters/pyright/plugin.yaml index c317b4fba..9939a4d07 100644 --- a/linters/pyright/plugin.yaml +++ b/linters/pyright/plugin.yaml @@ -11,6 +11,7 @@ lint: - name: pyright files: [python] suggest_if: config_present + description: Static type checker for Python commands: - name: lint output: sarif diff --git a/linters/regal/plugin.yaml b/linters/regal/plugin.yaml index 767f9c10d..ff0dfc4f1 100644 --- a/linters/regal/plugin.yaml +++ b/linters/regal/plugin.yaml @@ -27,6 +27,7 @@ lint: main_tool: regal known_good_version: 0.18.0 suggest_if: config_present + description: Linter for Rego files direct_configs: - .regal/config.yaml commands: diff --git a/linters/remark-lint/plugin.yaml b/linters/remark-lint/plugin.yaml index 250cbd66e..3f91593e4 100644 --- a/linters/remark-lint/plugin.yaml +++ b/linters/remark-lint/plugin.yaml @@ -4,6 +4,7 @@ lint: - name: remark-lint supported_platforms: [linux, macos] files: [markdown] + description: A markdown linter and formatter package: remark-cli extra_packages: - remark-preset-lint-consistent diff --git a/linters/renovate/plugin.yaml b/linters/renovate/plugin.yaml index d61bbcefb..f3b7d5b62 100644 --- a/linters/renovate/plugin.yaml +++ b/linters/renovate/plugin.yaml @@ -11,6 +11,7 @@ lint: - name: renovate files: [renovate-config] tools: [renovate] + description: Validates Renovate configuration files commands: - name: validate platforms: [windows] diff --git a/linters/rome/plugin.yaml b/linters/rome/plugin.yaml index 6b7b6baa3..46ece471b 100644 --- a/linters/rome/plugin.yaml +++ b/linters/rome/plugin.yaml @@ -10,6 +10,7 @@ lint: definitions: # No longer maintained. Succeeded by the biome linter+formatter - name: rome + description: A static analyzer for web projects files: - typescript - javascript diff --git a/linters/rubocop/plugin.yaml b/linters/rubocop/plugin.yaml index 430a444af..5c449bbd1 100644 --- a/linters/rubocop/plugin.yaml +++ b/linters/rubocop/plugin.yaml @@ -2,6 +2,7 @@ version: 0.1 lint: definitions: - name: rubocop + description: A Ruby static code analyzer and formatter files: [ruby, gemspec] direct_configs: [.rubocop.yml] suggest_if: config_present diff --git a/linters/ruff/plugin.yaml b/linters/ruff/plugin.yaml index 51fcf5f71..ad2d5b9ad 100644 --- a/linters/ruff/plugin.yaml +++ b/linters/ruff/plugin.yaml @@ -10,6 +10,7 @@ lint: definitions: - name: ruff files: [python, python-interface] + description: A Python linter and formatter commands: - name: lint # As of ruff v0.1.0, --format is replaced with --output-format diff --git a/linters/rufo/plugin.yaml b/linters/rufo/plugin.yaml index 9fb8a3875..053810ab4 100644 --- a/linters/rufo/plugin.yaml +++ b/linters/rufo/plugin.yaml @@ -10,6 +10,7 @@ lint: definitions: - name: rufo files: [ruby] + description: A Ruby formatter commands: - name: format output: rewrite diff --git a/linters/rustfmt/plugin.yaml b/linters/rustfmt/plugin.yaml index b3408ebde..dca9105b1 100644 --- a/linters/rustfmt/plugin.yaml +++ b/linters/rustfmt/plugin.yaml @@ -4,6 +4,7 @@ lint: - name: rustfmt files: [rust] download: rust + description: A Rust formatter commands: - name: format output: rewrite diff --git a/linters/scalafmt/plugin.yaml b/linters/scalafmt/plugin.yaml index 2f4c47a0e..a1ce10dcb 100644 --- a/linters/scalafmt/plugin.yaml +++ b/linters/scalafmt/plugin.yaml @@ -28,6 +28,7 @@ lint: tools: [scalafmt] direct_configs: [.scalafmt.conf] suggest_if: config_present + description: A Scala formatter commands: - name: format output: rewrite diff --git a/linters/semgrep/plugin.yaml b/linters/semgrep/plugin.yaml index cd752a03d..9a0af399a 100644 --- a/linters/semgrep/plugin.yaml +++ b/linters/semgrep/plugin.yaml @@ -9,6 +9,7 @@ tools: lint: definitions: - name: semgrep + description: Find bugs and enforce code standards supported_platforms: [linux, macos] files: [ALL] tools: [semgrep] diff --git a/linters/shellcheck/plugin.yaml b/linters/shellcheck/plugin.yaml index fea586b63..712e96ccf 100644 --- a/linters/shellcheck/plugin.yaml +++ b/linters/shellcheck/plugin.yaml @@ -31,6 +31,7 @@ lint: - name: shellcheck files: [shell] tools: [shellcheck] + description: Finds bugs in your shell scripts commands: - name: lint # Custom parser type defined in the trunk cli to handle rubocop's JSON output. diff --git a/linters/shfmt/plugin.yaml b/linters/shfmt/plugin.yaml index f0004aba8..efbb30e64 100644 --- a/linters/shfmt/plugin.yaml +++ b/linters/shfmt/plugin.yaml @@ -11,6 +11,7 @@ lint: definitions: - name: shfmt files: [shell] + description: A shell formatter commands: - name: format output: shfmt diff --git a/linters/sourcery/plugin.yaml b/linters/sourcery/plugin.yaml index cd0646c2e..9f83d313f 100644 --- a/linters/sourcery/plugin.yaml +++ b/linters/sourcery/plugin.yaml @@ -3,6 +3,7 @@ lint: definitions: - name: sourcery files: [python] + description: Static analyzer for Python commands: - name: lint platforms: [linux, macos] diff --git a/linters/sql-formatter/plugin.yaml b/linters/sql-formatter/plugin.yaml index ec5de1e85..0c7424b09 100644 --- a/linters/sql-formatter/plugin.yaml +++ b/linters/sql-formatter/plugin.yaml @@ -10,6 +10,7 @@ lint: definitions: - name: sql-formatter files: [sql] + description: A SQL formatter commands: - output: rewrite # sql-formatter does not autodetect dialect, so this may not be sufficient for all setups diff --git a/linters/sqlfluff/plugin.yaml b/linters/sqlfluff/plugin.yaml index f4a7a12d3..139725a2c 100644 --- a/linters/sqlfluff/plugin.yaml +++ b/linters/sqlfluff/plugin.yaml @@ -11,6 +11,7 @@ lint: - name: sqlfluff files: [sql, sql-j2, dml, ddl] tools: [sqlfluff] + description: A dialect-flexible and configurable SQL linter known_good_version: 1.4.5 direct_configs: - .sqlfluff diff --git a/linters/sqlfmt/plugin.yaml b/linters/sqlfmt/plugin.yaml index a3cffcaac..8a62627e0 100644 --- a/linters/sqlfmt/plugin.yaml +++ b/linters/sqlfmt/plugin.yaml @@ -11,6 +11,7 @@ lint: - name: sqlfmt files: [sql, sql-j2] tools: [sqlfmt] + description: A SQL formatter known_good_version: 0.16.0 # trunk-ignore(yamllint/quoted-strings): see https://github.com/adrienverge/yamllint/issues/516 extra_packages: ["shandy-sqlfmt[jinjafmt]"] diff --git a/linters/standardrb/plugin.yaml b/linters/standardrb/plugin.yaml index e6ba71d25..d1efd3723 100644 --- a/linters/standardrb/plugin.yaml +++ b/linters/standardrb/plugin.yaml @@ -10,6 +10,7 @@ lint: definitions: - name: standardrb files: [ruby, gemspec] + description: Ruby's bikeshed-proof linter and formatter commands: - name: lint # Custom parser type defined in the trunk cli to handle rubocop's JSON output. diff --git a/linters/stringslint/plugin.yaml b/linters/stringslint/plugin.yaml index 2bcdb5fd2..b4f5d7123 100644 --- a/linters/stringslint/plugin.yaml +++ b/linters/stringslint/plugin.yaml @@ -23,6 +23,7 @@ lint: - xib - storyboard tools: [stringslint] + description: Ensures localized strings are complete and never unused commands: - name: lint output: regex diff --git a/linters/stylelint/plugin.yaml b/linters/stylelint/plugin.yaml index a1c18ab6e..d33e7640d 100644 --- a/linters/stylelint/plugin.yaml +++ b/linters/stylelint/plugin.yaml @@ -11,6 +11,7 @@ lint: - name: stylelint files: [css, sass] tools: [stylelint] + description: Over 100 built-in rules for modern CSS commands: - name: lint version: ">=16.0.0" diff --git a/linters/stylua/plugin.yaml b/linters/stylua/plugin.yaml index 5089789eb..9e84c4cae 100644 --- a/linters/stylua/plugin.yaml +++ b/linters/stylua/plugin.yaml @@ -22,6 +22,7 @@ lint: - name: stylua files: [lua] tools: [stylua] + description: An opinionated Lua formatter commands: - name: format output: rewrite diff --git a/linters/svgo/plugin.yaml b/linters/svgo/plugin.yaml index 7f9f2aa8f..e735fd124 100644 --- a/linters/svgo/plugin.yaml +++ b/linters/svgo/plugin.yaml @@ -11,6 +11,7 @@ lint: # while svgo could be a formatter, it is optimizing, not formatting, so it's more intuitive to run on `trunk check` - name: svgo files: [svg] + description: Optimize SVG files commands: - name: fmt output: rewrite diff --git a/linters/swiftformat/plugin.yaml b/linters/swiftformat/plugin.yaml index 0277ae183..0b42f6429 100644 --- a/linters/swiftformat/plugin.yaml +++ b/linters/swiftformat/plugin.yaml @@ -17,6 +17,7 @@ lint: - name: swiftformat files: [swift] tools: [swiftformat] + description: Formatter for Swift commands: - name: format output: rewrite diff --git a/linters/swiftlint/plugin.yaml b/linters/swiftlint/plugin.yaml index a5b462798..4191c696f 100644 --- a/linters/swiftlint/plugin.yaml +++ b/linters/swiftlint/plugin.yaml @@ -15,6 +15,7 @@ tools: lint: definitions: - name: swiftlint + description: Enforces Swift style and conventions files: - swift tools: [swiftlint] diff --git a/linters/taplo/plugin.yaml b/linters/taplo/plugin.yaml index 389fa5b86..06742af7a 100644 --- a/linters/taplo/plugin.yaml +++ b/linters/taplo/plugin.yaml @@ -79,6 +79,7 @@ lint: - name: taplo files: [toml] tools: [taplo] + description: Validate and format TOML files commands: - name: lint # Custom parser type defined in the trunk cli to handle taplo's output. diff --git a/linters/terraform/plugin.yaml b/linters/terraform/plugin.yaml index 20bbf4add..adf728c2d 100644 --- a/linters/terraform/plugin.yaml +++ b/linters/terraform/plugin.yaml @@ -4,6 +4,7 @@ lint: - name: terraform files: [terraform] tools: [terraform] + description: Validate and format terraform files commands: - name: validate # Custom parser type defined in the trunk cli to handle terraform's JSON output. diff --git a/linters/terragrunt/plugin.yaml b/linters/terragrunt/plugin.yaml index ff7c032c0..6aab17a1f 100644 --- a/linters/terragrunt/plugin.yaml +++ b/linters/terragrunt/plugin.yaml @@ -24,6 +24,7 @@ lint: definitions: - name: terragrunt tools: [terragrunt] + description: Maintain HCL files in a canonical format known_good_version: 0.45.8 files: [hcl] suggest_if: never diff --git a/linters/terrascan/plugin.yaml b/linters/terrascan/plugin.yaml index e166ee074..30c4c8b98 100644 --- a/linters/terrascan/plugin.yaml +++ b/linters/terrascan/plugin.yaml @@ -22,6 +22,7 @@ lint: - name: terrascan tools: [terrascan] known_good_version: 1.18.1 + description: A static code analyzer for IaC # terrascan does not support some modern terraform syntax. Don't auto-recommend. suggest_if: never commands: diff --git a/linters/tflint/plugin.yaml b/linters/tflint/plugin.yaml index e6a163d20..b2c91731e 100644 --- a/linters/tflint/plugin.yaml +++ b/linters/tflint/plugin.yaml @@ -25,6 +25,7 @@ lint: definitions: - name: tflint files: [terraform] + description: A pluggable Terraform linter commands: - name: lint output: sarif diff --git a/linters/tfsec/plugin.yaml b/linters/tfsec/plugin.yaml index 4c764ed9e..cd4287bd9 100644 --- a/linters/tfsec/plugin.yaml +++ b/linters/tfsec/plugin.yaml @@ -29,6 +29,7 @@ lint: tools: [tfsec] known_good_version: 1.28.1 suggest_if: never + description: Security scanner for your Terraform code commands: - name: lint output: sarif diff --git a/linters/tofu/plugin.yaml b/linters/tofu/plugin.yaml index 68e1bf66b..ef2cc66c2 100644 --- a/linters/tofu/plugin.yaml +++ b/linters/tofu/plugin.yaml @@ -4,6 +4,7 @@ lint: - name: tofu files: [terraform] tools: [tofu] + description: A Terraform validator and formatter commands: - name: validate # Custom parser type defined in the trunk cli to handle tofu's JSON output. diff --git a/linters/trivy/plugin.yaml b/linters/trivy/plugin.yaml index 9af9f4278..05cb25422 100644 --- a/linters/trivy/plugin.yaml +++ b/linters/trivy/plugin.yaml @@ -28,6 +28,7 @@ lint: - name: trivy tools: [trivy] suggest_if: files_present + description: A comprehensive and versatile security scanner known_good_version: 0.44.1 commands: - name: fs-vuln diff --git a/linters/trufflehog/plugin.yaml b/linters/trufflehog/plugin.yaml index 7958ad38e..b3952118e 100644 --- a/linters/trufflehog/plugin.yaml +++ b/linters/trufflehog/plugin.yaml @@ -21,6 +21,7 @@ lint: - name: trufflehog files: [ALL] tools: [trufflehog] + description: Validated and versatile secrets scanner known_good_version: 3.59.0 known_bad_versions: [3.41.0, 3.45.0, 3.60.1, 3.60.2] commands: diff --git a/linters/trunk-toolbox/plugin.yaml b/linters/trunk-toolbox/plugin.yaml index b5ca64718..5be873d4a 100644 --- a/linters/trunk-toolbox/plugin.yaml +++ b/linters/trunk-toolbox/plugin.yaml @@ -23,6 +23,7 @@ lint: - name: trunk-toolbox main_tool: trunk-toolbox files: [ALL] + description: Collection of universal linting tools commands: - name: lint run: trunk-toolbox --upstream=${upstream-ref} --results=${tmpfile} ${target} diff --git a/linters/txtpbfmt/plugin.yaml b/linters/txtpbfmt/plugin.yaml index 2e065a221..a6eb25cbb 100644 --- a/linters/txtpbfmt/plugin.yaml +++ b/linters/txtpbfmt/plugin.yaml @@ -11,6 +11,7 @@ lint: - name: txtpbfmt files: [textproto] tools: [txtpbfmt] + description: A formatter for textproto files commands: - name: format output: rewrite diff --git a/linters/yamllint/plugin.yaml b/linters/yamllint/plugin.yaml index 98a4a5a7e..449d067ff 100644 --- a/linters/yamllint/plugin.yaml +++ b/linters/yamllint/plugin.yaml @@ -10,6 +10,7 @@ lint: definitions: - name: yamllint files: [yaml] + description: Validate, Verify and Reformat your YAML documents commands: - output: regex parse_regex: diff --git a/linters/yapf/plugin.yaml b/linters/yapf/plugin.yaml index e51d016a2..d89891fd5 100644 --- a/linters/yapf/plugin.yaml +++ b/linters/yapf/plugin.yaml @@ -11,6 +11,7 @@ lint: definitions: - name: yapf files: [python] + description: A formatter for Python files commands: - name: format output: rewrite diff --git a/plugin.yaml b/plugin.yaml index e2fe55ca7..4b1358141 100644 --- a/plugin.yaml +++ b/plugin.yaml @@ -1,6 +1,6 @@ version: 0.1 # IfChange -required_trunk_version: ">=1.21.1-beta.16" +required_trunk_version: ">=1.21.1-beta.20" # ThenChange tests/repo_tests/config_check.test.ts environments: diff --git a/tests/repo_tests/config_check.test.ts b/tests/repo_tests/config_check.test.ts index d2b964c96..bd364d848 100644 --- a/tests/repo_tests/config_check.test.ts +++ b/tests/repo_tests/config_check.test.ts @@ -25,7 +25,7 @@ describe("Global config health check", () => { setupTrunk: true, // NOTE: This version should be kept compatible in lockstep with the `required_trunk_version` in plugin.yaml // IfChange - trunkVersion: "1.21.1-beta.16", + trunkVersion: "1.21.1-beta.20", // ThenChange plugin.yaml });