Skip to content

Latest commit

 

History

History
45 lines (25 loc) · 3.33 KB

compatibility.md

File metadata and controls

45 lines (25 loc) · 3.33 KB

Compatibility

Linux

Trunk will run on most Linux flavors, including Ubuntu, Arch, and others. We do require glibc version 2.19 or later. Alpine Linux is not supported.

macOS

Trunk will run on macOS version 10.15 or later.

Windows

Trunk only supports Windows with the following versions and above:

ToolWhere to ModifyMinimum Required Version
CLIcli version in .trunk/trunk.yaml1.13.0
Pluginsref for the trunk plugin in .trunk/trunk.yamlv1.0.0
VSCodeReload VSCode to update3.4.4

You will also need to install C and C++ runtime libraries to run some linters.

Getting in touch

Thank you for being a beta tester of Trunk Check on Windows! We are actively working to improve the experience. If you have any feedback or questions, please contact us directly on Slack.

If you want to override a repo-wide setting just for your Windows machine, you can modify your .trunk/user.yaml.

Supported Features

We intend to bring full feature support to Windows for Trunk. Currently, the following features are supported:

Plugin Compatibility

{% hint style="info" %} This section was last updated for Plugins v1.2.0 {% endhint %}

Trunk runs most linters on all platforms. However, some linters are not yet supported on Windows. For a full list of all linters, see our Plugins repo.

LinterPlans for Support
ansible-lintOnly supported on WSL
clang-formatLong-term plans for LLVM linter support
clang-tidyLong-term plans for LLVM linter support
detekt-gradleLong-term plans for support
include-what-you-useLong-term plans for LLVM linter support
nixpkgs-fmtLong-term plans for support
perlcriticNo immediate plans for support
perltidyNo immediate plans for support
scalafmtNo download available for Windows
semgrepNo download available for Windows
shellcheckNo download available for Windows
stringslintOnly supported on MacOS
swiftformatOnly supported on MacOS
swiftlintOnly supported on MacOS
taploNo download available for Windows

Backward Compatibility

We generally strive to maintain backward compatibility between the Trunk Launcher and the Trunk binary, but you may need to occasionally upgrade the launcher to support the newest version of Trunk.