This repository is the official Trunk.io repo containing Trunk's integrations
for linters, formatters, security tools, githooks, and default configs. By default, all Trunk users
import this repo as a plugin, via this snippet in .trunk/trunk.yaml:
plugins: sources: - id: trunk uri: https://github.com/trunk-io/plugins ref: v1.5.0
This repo is open to contributions! See our contribution guidelines and join our slack community for help. If you're adding new tools, please see our testing guide as well!
Enable the following tools via:
trunk check enable {linter}You can think of Trunk Actions as IFTTT for your repository. An action is a command that is run in reaction to a specified trigger. Triggers can be git-hooks, file modifications, time-based, or manually run. See docs for more details.
Enable trunk actions via:
trunk actions enable {action}| action | description |
|---|---|
buf-gen |
run buf on .proto file change |
commitizen |
enforce conventional commits and manage releases |
commitlint |
enforce conventional commit message for your local commits |
go-mod-tidy |
automatically tidy go.mod file |
go-mod-tidy-vendor |
automatically tidy and vendor go.mod file |
git-blame-ignore-revs |
automatically configure git to use .git-blame-ignore-revs |
npm-check |
check whether NPM installation is up to date |
terraform-docs |
generate documentation from Terraform modules |
poetry-check, poetry-lock, poetry-export, poetry-install |
hooks to enforce poetry configuration |
yarn-check |
check whether Yarn installation is up to date |
This repository also defines configuration for Trunk Tools, which provides hermetic management of
different CLI tools. You can run trunk tools list to view all supported tools. Check out our
docs.
Our goal is to make engineering faster, more efficient and dare we say - more fun. This repository will hopefully allow our community to share ideas on the best tools and best practices/workflows to make everyone's job of building code a little bit easier, a little bit faster, and maybe in the process - a little bit more fun. Read more about Trunk Check.
Some linters provide built-in formatters or autofix options that don't always produce ideal outputs, especially in conjunction with other formatters. Trunk supports defining autofix options for these linters, but has their formatting turned off by default. An example of this is sqlfluff:
- name: sqlfluff files: [sql, sql-j2, dml, ddl] runtime: python package: sqlfluff direct_configs: - .sqlfluff commands: - name: lint run: sqlfluff lint ${target} --format json --dialect ansi --nofail output: sarif success_codes: [0] read_output_from: stdout parser: runtime: python run: ${plugin}/linters/sqlfluff/sqlfluff_to_sarif.py - name: fix run: sqlfluff fix ${target} --dialect ansi --disable-progress-bar --force output: rewrite formatter: true in_place: true success_codes: [0] enabled: false
The fix subcommand has enabled: false, so when you run trunk check enable sqlfluff, only the
lint subcommand is enabled. To override this behavior, specify in your trunk.yaml:
lint: enabled: - sqlfluff@<version>: commands: [lint, fix]