You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: code-quality/code-quality.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,5 @@
1
1
---
2
-
description: 'Metalinter for over 100 code checking tools: CLI, IDE, and on the web.'
2
+
description: Metalinter for over 100 code checking tools.
3
3
---
4
4
5
5
# Overview
@@ -24,7 +24,7 @@ Maintaining consistency in open-source repos is hard. That's why Trunk Code Qual
24
24
25
25
{% hint style="danger" %}
26
26
**Deprecation Warning**\
27
-
The Trunk Code Quality web app, Code Quality on PRs, and Code Quality Nightly will soon be deprecated. Follow the instructions on the [Linting in CI](setup-and-installation/prevent-new-issues/) page to migrate off these features.
27
+
The Trunk Code Quality web app, Code Quality on PRs, and Code Quality Nightly will soon be deprecated. Follow the instructions on the [Linting in CI](setup-and-installation/prevent-new-issues.md) page to migrate off these features.
28
28
{% endhint %}
29
29
30
30
<tabledata-view="cards"><thead><tr><th></th><th></th><th></th><thdata-hiddendata-card-targetdata-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Trunk CLI</strong></td><td>Initialize Code Quality in your projects using the Trunk CLI.</td><td></td><td><ahref="setup-and-installation/initialize-trunk.md">initialize-trunk.md</a></td></tr><tr><td><strong>IDE Integration</strong></td><td>Initialize Code Quality in your projects using a VSCode extension.</td><td></td><td><ahref="ide-integration/">ide-integration</a></td></tr></tbody></table>
Copy file name to clipboardExpand all lines: code-quality/overview/README.md
+2-11Lines changed: 2 additions & 11 deletions
Original file line number
Diff line number
Diff line change
@@ -24,7 +24,7 @@ Trunk will install, manage, and run tools like linters and formatters for you. T
24
24
25
25
[Adopting new linters is a pain](https://trunk.io/blog/reasons-developers-hate-linters) because of the large amount of upfront configuration and fixes needed. Enabling a new linter or formatter in an old repo will yield thousands of issues, most of which might not have auto fixes.
26
26
27
-
Trunk supports [hold-the-line](how-does-it-work.md#hold-the-line) to lint only new issues introduced with a commit or PR, to let developers adopt new linters fast, focus on preventing new issues first, and[ report on existing issues nightly](../ci-setup/) to fix later. Waiting will only accumulate debt; stop debt accumulation immediately and fix as you code.
27
+
Trunk supports [hold-the-line](how-does-it-work.md#hold-the-line) to lint only new issues introduced with a commit or PR, to let developers adopt new linters fast, focus on preventing new issues first, and[ report on existing issues nightly](../ci-setup/github-integration.md) to fix later. Waiting will only accumulate debt; stop debt accumulation immediately and fix as you code.
28
28
29
29
#### Linters take too long to run
30
30
@@ -38,10 +38,6 @@ Many linters don't install neatly through a package manager, and for those that
38
38
39
39
Trunk Code Quality uses an extensible [plugin system](../../references/cli/configuration/plugins/), so you can define linters to [auto-enable](../../references/cli/configuration/lint/auto-enable.md) and [share linter configurations](../linters/shared-configs.md) to standardize across code bases.
40
40
41
-
#### Lack of consistent output and reporting
42
-
43
-
Every linter outputs differently. If you've got a backlog of issues like ESLint errors, OSV Scanner dependency vulnerabilities, poorly optimized images, and vulnerabilities in your Docker Config, you'd want to see them in an [organized report](../ci-setup/github-integration.md), sorted by severity or by file, with [consistent format](../../references/cli/configuration/lint/output.md). Trunk Code Quality can do this.
44
-
45
41
### Features
46
42
47
43
Trunk Code Quality helps address these issues by:
@@ -62,11 +58,7 @@ Trunk Code Quality speeds up static analysis by using a background daemon to che
62
58
63
59
#### **Time-consuming PR iteration and triage**
64
60
65
-
Trunk Code Quality speeds up PR iteration by showing the _same_ results locally and [on CI](../ci-setup/), improving PR triage. It can optionally also function as a [githooks manager](../../references/cli/getting-started/actions/git-hooks.md) to reject `git push`es unless they're passing `trunk check`.
66
-
67
-
#### **Lack of team visibility into the repo's health**
68
-
69
-
Trunk Code Quality improves team communication by providing a [web app](https://app.trunk.io/login?intent=code%20quality) for repo stats and [Slack notifications](../../integration-for-slack.md), ensuring everyone on the team is aware of the current health of your repo.
61
+
Trunk Code Quality speeds up PR iteration by showing the _same_ results locally and [on CI](../setup-and-installation/prevent-new-issues.md), improving PR triage. It can optionally also function as a [githooks manager](../../references/cli/getting-started/actions/git-hooks.md) to reject `git push`es unless they're passing `trunk check`.
70
62
71
63
### Components
72
64
@@ -76,4 +68,3 @@ Trunk Code Quality has many components that fit into different stages of your de
76
68
***In cloud development environments:** Trunk can be used in [GitHub Codespaces](../../cli/configuration/github-codespaces.md).
77
69
***Before committing and pushing,** Trunk can automatically run linters and formatters using Git hooks.
78
70
***On PRs and in CI:** Using our GitHub integration, setting up your own GitHub workflows, or in your own CI environments.
79
-
***Reporting and analytics**: Using the Trunk Web App.
Copy file name to clipboardExpand all lines: code-quality/overview/how-does-it-work.md
+1-7Lines changed: 1 addition & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -54,10 +54,4 @@ This can be overridden by defining your own plugin repo to import, overriding in
54
54
55
55
Trunk works in CI. Trunk Code Quality provides [GitHub integration](../ci-setup/github-integration.md) and can run in any other CI environment. This lets you check Code Quality in every PR with consistent config and consistent results.
56
56
57
-
[Learn more about Code Quality in CI.](../ci-setup/)
58
-
59
-
### Nightly reports
60
-
61
-
Trunk Code Quality allows you to [upload results](../ci-setup/manual-setup.md#other-providers) to the [Trunk Web App](https://app.trunk.io/login?intent=code%20quality), which provides a dashboard to view your current code base issues and track code base health over time.
62
-
63
-
[Learn more about nightly reporting.](how-does-it-work.md#nightly-reports)
57
+
[Learn more about Code Quality in CI.](../setup-and-installation/prevent-new-issues.md)
Copy file name to clipboardExpand all lines: code-quality/setup-and-installation/README.md
+2-2Lines changed: 2 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,11 @@
2
2
3
3
{% hint style="danger" %}
4
4
**Deprecation Warning**\
5
-
The Trunk Code Quality web app, Code Quality on PRs, and Code Quality Nightly will soon be deprecated. Follow the instructions on the [Linting in CI](prevent-new-issues/) page to migrate off these features.
5
+
The Trunk Code Quality web app, Code Quality on PRs, and Code Quality Nightly will soon be deprecated. Follow the instructions on the [Linting in CI](prevent-new-issues.md) page to migrate off these features.
6
6
{% endhint %}
7
7
8
8
Trunk Code Quality is easy to adopt for new and legacy projects alike. You can run Trunk Code Quality using your existing linter configurations, incrementally address existing problems, and prevent new issues from being committed to your repo.
9
9
10
10
You can start using Code Quality in your repos in 4 steps.
11
11
12
-
<table data-card-size="large" data-view="cards"><thead><tr><th></th><th></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Step 1: Initialize Trunk</strong></td><td>Initialize Trunk in your repo to generate Trunk config files and get linter recommendations based on your project's files.</td><td></td><td><a href="initialize-trunk.md">initialize-trunk.md</a></td></tr><tr><td><strong>Step 2: Check for issues</strong></td><td>Check for existing issues in your project. You can address problems up front, use <strong>hold-the-line</strong> to fix them incrementally, and configure ignores for irrelevant issues. </td><td></td><td><a href="deal-with-existing-issues.md">deal-with-existing-issues.md</a></td></tr><tr><td><strong>Step 3: Prevent New Issues</strong></td><td>Set up automated runs on commits, before pushes, and on PRs to prevent new issues from appearing in your repo.</td><td></td><td><a href="prevent-new-issues/">prevent-new-issues</a></td></tr><tr><td><strong>Step 4: Nightly Reports</strong></td><td>Code Standards evolve, and new vulnerabilities are discovered daily. Run regular Code Quality checks to discover issues in your repo.</td><td></td><td><a href="../ci-setup/github-integration.md">github-integration.md</a></td></tr></tbody></table>
12
+
<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Step 1: Initialize Trunk</strong></td><td>Initialize Trunk in your repo to generate Trunk config files and get linter recommendations based on your project's files.</td><td></td><td><a href="initialize-trunk.md">initialize-trunk.md</a></td></tr><tr><td><strong>Step 2: Check for issues</strong></td><td>Check for existing issues in your project. You can address problems up front, use <strong>hold-the-line</strong> to fix them incrementally, and configure ignores for irrelevant issues. </td><td></td><td><a href="deal-with-existing-issues.md">deal-with-existing-issues.md</a></td></tr><tr><td><strong>Step 3: Prevent New Issues</strong></td><td>Set up automated runs on commits, before pushes, and on PRs to prevent new issues from appearing in your repo.</td><td></td><td><a href="prevent-new-issues.md">prevent-new-issues.md</a></td></tr></tbody></table>
0 commit comments