Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update links to custom linters and parsers documentation #907

Merged
merged 2 commits into from
Nov 7, 2024
Merged

Update links to custom linters and parsers documentation #907

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c7bc6a7
Update links to custom linters and parsers documentation
amkisko Nov 6, 2024
b6de029
fmt
TylerJang27 Nov 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,8 +69,9 @@ To add a new linter:
```

3. Add your linter definition to `plugin.yaml` (consult the docs for [custom linters] and [custom
parsers] to understand how it should be defined). Most linters in this repository are defined as
tools as well, so that they can be easily run manually from the command line.
parsers]
to understand how it should be defined). Most linters in this repository are defined as tools as
well, so that they can be easily run manually from the command line.
4. Run `trunk check enable <my-linter>` to enable your linter, and run `trunk check` to verify that
the configuration is valid and that you get desired diagnostics. Running `trunk check --verbose`
can help provide greater insights when debugging. You may also wish to run on your test data,
Expand All @@ -81,8 +82,8 @@ To add a new linter:
6. Revert any `.trunk/trunk.yaml` changes, and run `trunk check` to lint your changes.
7. Open a PR!

[custom linters]: https://docs.trunk.io/check/custom-linters
[custom parsers]: https://docs.trunk.io/check/custom-parsers
[custom linters]: https://docs.trunk.io/code-quality/linters/custom-linters
[custom parsers]: https://docs.trunk.io/cli/configuration/lint/output-parsing

## Tools

Expand Down
Loading