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
The following sections describe how Codacy calculates each supported metric and where you can see each metric on the Codacy UI:
10
10
11
-
-[Grade](#grade)
12
-
-[Issues](#issues)
13
-
-[Complexity](#complexity)
14
-
-[Duplication](#duplication)
15
-
-[Code coverage](#code-coverage)
11
+
-[Which metrics does Codacy calculate?](#which-metrics-does-codacy-calculate)
12
+
-[Grade](#grade)
13
+
-[Issues](#issues)
14
+
-[Complexity](#complexity)
15
+
-[Duplication](#duplication)
16
+
-[Code coverage](#code-coverage)
17
+
-[See also](#see-also)
16
18
17
19
!!! note
18
20
Depending on certain characteristics of your repository, such as the number of source code files and their size, Codacy may [apply limits to the code analysis](does-codacy-place-limits-on-the-code-analysis.md) that impact the calculation of the supported metrics.
Copy file name to clipboardExpand all lines: docs/getting-started/integrating-codacy-with-intellij-ides.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Integrating Codacy with IntelliJ IDEs
2
2
3
-
The [Codacy IntelliJ plugin](https://github.com/codacy/codacy-intellij-extension) is an open-source plugin for IntelliJ IDEs that lets you review the result of the Codacy analysis for a pull request, get the full list of problems found, and navigate to any Quality issue that you want to review and fix.
3
+
The [Codacy IntelliJ plugin](https://github.com/codacy/codacy-intellij-extension) is an open-source plugin for IntelliJ IDEs that lets you review the result of the Codacy analysis for a pull request, get the full list of problems found, and navigate to any issue that you want to review and fix.
4
4
5
5
!!! info "To use this plugin you need a [Codacy account](https://www.codacy.com/signup-codacy)"
6
6
@@ -12,15 +12,15 @@ The main view of the Codacy IntelliJ plugin provides a summary of the code quali
12
12
13
13
In the main view, you can find the following information:
14
14
15
-
- The **Quality status** of the pull request, either up to standards or not up to standards, based on the [Quality gates](../repositories-configure/adjusting-quality-gates.md) set for the repository.
15
+
- The **Status** of the pull request, either up to standards or not up to standards, based on the [Gates](../repositories-configure/adjusting-quality-gates.md) set for the repository.
16
16
17
-
- Any **Quality issues** introduced or fixed by the pull request. These are the same issues you find in the [Quality Issues tabs](../repositories/pull-requests.md#issues-tabs) in the Codacy app and are also visible in IntelliJ's Problems tab.
17
+
- Any **issues** introduced or fixed by the pull request. These are the same issues you find in the [Issues tabs](../repositories/pull-requests.md#issues-tabs) in the Codacy app and are also visible in IntelliJ's Problems tab.
18
18
19
-
When this item is expanded, the number next to each file name is the total number of Quality issues that the pull request adds to that file.
19
+
When this item is expanded, the number next to each file name is the total number of issues that the pull request adds to that file.
20
20
21
21
- The **diff coverage** introduced by the pull request. The percentage next to each file name is the coverage variation for that file.
22
22
23
-
- Sequences of **duplicate code** (clones) introduced by the pull request. These are the same ones you find in the [Quality Duplication tabs](../repositories/pull-requests.md#duplication-tabs) in the Codacy app.
23
+
- Sequences of **duplicate code** (clones) introduced by the pull request. These are the same ones you find in the [Duplication tabs](../repositories/pull-requests.md#duplication-tabs) in the Codacy app.
24
24
25
25
- Variations in **code complexity** introduced by the pull request.
26
26
@@ -56,12 +56,12 @@ After completing these steps, the main view shows the result of the latest Codac
56
56
57
57
## Reviewing pull request issues
58
58
59
-
In the **Problems tool window**, Codacy displays the same Quality issues you find in the main view and lets you navigate to the exact line of code where the issue was found.
59
+
In the **Problems tool window**, Codacy displays the same issues you find in the main view and lets you navigate to the exact line of code where the issue was found.
60
60
61
61
!!! note
62
62
Code coverage, duplicates, and complexity aren't currently shown in the Problems tool window.
Copy file name to clipboardExpand all lines: docs/getting-started/integrating-codacy-with-visual-studio-code.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
The [Codacy Visual Studio Code extension](https://github.com/codacy/codacy-vscode-extension) is an open-source project that enables developers to review directly in VS Code the result of Codacy analysis for the pull requests they’re working on.
4
4
5
-
Use this extension to get the full list of problems found by Codacy for a pull request and navigate to any Quality issue that you want to review and fix.
5
+
Use this extension to get the full list of problems found by Codacy for a pull request and navigate to any issue that you want to review and fix.
6
6
7
7
!!! info "To use this extension you need a [Codacy account](https://www.codacy.com/signup-codacy)"
8
8
@@ -20,11 +20,11 @@ The main view of the extension displays information about the code quality and c
20
20
21
21
The **Pull request status** tab displays the following information for the pull request of the currently checked-out branch:
22
22
23
-
- The **Quality status** of the pull request, either up to standards or not up to standards, based on the [Quality gates](../repositories-configure/adjusting-quality-gates.md) set for the repository.
23
+
- The **Status** of the pull request, either up to standards or not up to standards, based on the [Gates](../repositories-configure/adjusting-quality-gates.md) set for the repository.
24
24
25
-
- Any **Quality issues** introduced or fixed by the pull request. These are the same issues you find in the [Quality Issues tabs](../repositories/pull-requests.md#issues-tabs) in the Codacy app and are also visible in VS Code's Problems tab.
25
+
- Any **issues** introduced or fixed by the pull request. These are the same issues you find in the [Issues tabs](../repositories/pull-requests.md#issues-tabs) in the Codacy app and are also visible in VS Code's Problems tab.
26
26
27
-
When this item is expanded, the number next to each file name is the total number of Quality issues that the pull request adds to or removes from that file. The number farther to the right, added by VS Code, is the total number of problems in that file, which may or may not be Quality issues from Codacy. If there are any Medium or Critical Quality issues, the file name is also highlighted in yellow (Medium) or red (Critical).
27
+
When this item is expanded, the number next to each file name is the total number of issues that the pull request adds to or removes from that file. The number farther to the right, added by VS Code, is the total number of problems in that file, which may or may not be issues from Codacy. If there are any Medium or Critical issues, the file name is also highlighted in yellow (Medium) or red (Critical).
- Sequences of **duplicate code** (clones) introduced by the pull request. These are the same ones you find in the [Quality Duplication tabs](../repositories/pull-requests.md#duplication-tabs) in the Codacy app.
37
+
- Sequences of **duplicate code** (clones) introduced by the pull request. These are the same ones you find in the [Duplication tabs](../repositories/pull-requests.md#duplication-tabs) in the Codacy app.
38
38
39
39
- Variations in **code complexity** introduced by the pull request.
40
40
@@ -48,23 +48,23 @@ The **Open Pull Requests** tab lists all open pull requests for the repository,
48
48
49
49
- Analyzing, if Codacy is analyzing the branch.
50
50
51
-
- Up to standards or not up to standards, based on the [Quality gates](../repositories-configure/adjusting-quality-gates.md) set for the repository.
51
+
- Up to standards or not up to standards, based on the [Gates](../repositories-configure/adjusting-quality-gates.md) set for the repository.
52
52
53
53
- The author of the pull request.
54
54
55
55
- The source and target branches of the pull request.
56
56
57
-
- Any **Quality issues** introduced or fixed by the pull request. These are the same issues you find in the [Quality Issues tabs](../repositories/pull-requests.md#issues-tabs) in the Codacy app.
57
+
- Any **issues** introduced or fixed by the pull request. These are the same issues you find in the [Issues tabs](../repositories/pull-requests.md#issues-tabs) in the Codacy app.
58
58
59
-
- Sequences of **duplicate code** (clones) introduced by the pull request. These are the same ones you find in the [Quality Duplication tabs](../repositories/pull-requests.md#duplication-tabs) in the Codacy app.
59
+
- Sequences of **duplicate code** (clones) introduced by the pull request. These are the same ones you find in the [Duplication tabs](../repositories/pull-requests.md#duplication-tabs) in the Codacy app.
60
60
61
61
- Variations in **code complexity** introduced by the pull request. This is the same value you find on the [Pull request quality overview](../repositories/pull-requests.md#quality-overview) in the Codacy app.
The **Analyzed Branch** tab appears if you switch to an analyzed branch that doesn't have an open pull request, such as the `main` or `master` branch. This tab shows an overview of the Quality issues found in that branch, grouped by recently added, introduced by the current user, issue category, and issue severity.
67
+
The **Analyzed Branch** tab appears if you switch to an analyzed branch that doesn't have an open pull request, such as the `main` or `master` branch. This tab shows an overview of the issues found in that branch, grouped by recently added, introduced by the current user, issue category, and issue severity.
68
68
69
69
See [how to manage the analysis of your repository's branches](../repositories-configure/managing-branches.md).
70
70
@@ -99,16 +99,16 @@ To see Codacy quality and coverage data for an open pull request, follow these s
99
99
100
100
1. Check out the pull request of interest. You can do it either manually or from the **Open Pull Requests** tab, by clicking the arrow button or using the contextual right-click menu.
101
101
102
-
After completing these steps, the main view shows the result of the latest Codacy analysis for the pull request. The VS Code Problems tab lists the Quality issues found.
102
+
After completing these steps, the main view shows the result of the latest Codacy analysis for the pull request. The VS Code Problems tab lists the issues found.
103
103
104
104
## Reviewing pull request issues
105
105
106
-
In the **Problems tab**, Codacy displays the same Quality issues you find in the **Status tab** and lets you navigate to the exact line of code where the issue was found.
106
+
In the **Problems tab**, Codacy displays the same issues you find in the **Status tab** and lets you navigate to the exact line of code where the issue was found.
107
107
108
108
!!! note
109
109
Code coverage, duplicates, and complexity aren't currently shown in the Problems tab.
110
110
111
-
To review Quality issues:
111
+
To review issues:
112
112
113
113
1. Open the **Problems tab** (use `Ctrl+Shift+M` on Windows/Linux or `Cmd+Shift+M` on macOS).
-**New issues are over:** Pull requests or commits are marked not up to standards if the number of issues introduced that have at least the specified severity level is higher than the set value.
20
20
-**New security issues are over:** Pull requests or commits are marked not up to standards if the number of security issues introduced that have at least the specified severity level is higher than the set value.
Copy file name to clipboardExpand all lines: docs/repositories-configure/adjusting-quality-goals.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,11 +2,11 @@
2
2
3
3
Adjust the **quality goals** to help you monitor the progress of the code quality in your repository dashboard, and configure which files Codacy considers complex or duplicated.
4
4
5
-
Codacy displays the quality goals as dashed lines on the [quality evolution chart](../repositories/repository-dashboard.md#quality-evolution-chart) to help you monitor the progress and overall quality status of your repository.
5
+
Codacy displays the quality goals as dashed lines on the [quality evolution chart](../repositories/repository-dashboard.md#evolution-chart) to help you monitor the progress and overall quality status of your repository.
6
6
7
7
To access the quality goals, open your repository **Settings**, tab **Goals**. The following screenshot displays the default configuration values:
Copy file name to clipboardExpand all lines: docs/repositories/commits.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,9 +3,9 @@ page_name: "commit"
3
3
file_name: "commits"
4
4
---
5
5
6
-
# Quality Commits page
6
+
# Commits page
7
7
8
-
The **Quality Commits page** displays an overview of the commits in your repository, such as the analysis status and the code quality metrics for each commit. This allows you to monitor the evolution of the code quality per commit in your repository.
8
+
The **Commits page** displays an overview of the commits in your repository, such as the analysis status and the code quality metrics for each commit. This allows you to monitor the evolution of the code quality per commit in your repository.
9
9
10
10
By default, the page lists the commits on the main branch of your repository, but if you have [more than one branch enabled](../repositories-configure/managing-branches.md) you can use the drop-down list at the top of the page to display commits on other branches.
Copy file name to clipboardExpand all lines: docs/repositories/coverage.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
# Quality Coverage page
1
+
# Coverage page
2
2
3
-
The **Quality Coverage page** displays the current code coverage information in your [enabled repository branches](../repositories-configure/managing-branches.md).
3
+
The **Coverage page** displays the current code coverage information in your [enabled repository branches](../repositories-configure/managing-branches.md).
4
4
5
5
If your repository doesn't have coverage set up, you can learn more on how to [add coverage to your repository](../coverage-reporter/index.md).
Copy file name to clipboardExpand all lines: docs/repositories/files.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
# Quality Files page
1
+
# Files page
2
2
3
-
The **Quality Files page** displays the current code quality information for each analyzed file in your [enabled repository branches](../repositories-configure/managing-branches.md).
3
+
The **Files page** displays the current code quality information for each analyzed file in your [enabled repository branches](../repositories-configure/managing-branches.md).
4
4
5
5
By default, the page lists the files on the main branch of your repository. However, if you have [more than one branch enabled](../repositories-configure/managing-branches.md), you can select other branches using the drop-down list at the top of the page.
6
6
@@ -36,7 +36,7 @@ The header of the file detail page displays the same code quality metrics as the
36
36
37
37
Depending on the available analysis information for the file, Codacy displays one or more of the following tabs:
38
38
39
-
-**Issues:** Shows the annotated source code on the left-hand side and the matching list of issues and issue distribution by severity on the right-hand side. Each listed issue includes the same information and options available on the [Quality Issues page](issues.md).
39
+
-**Issues:** Shows the annotated source code on the left-hand side and the matching list of issues and issue distribution by severity on the right-hand side. Each listed issue includes the same information and options available on the [Issues page](issues.md).
Copy file name to clipboardExpand all lines: docs/repositories/issues.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
-
# Quality Issues page
1
+
# Issues page
2
2
3
-
The **Quality Issues page** lists all the issues that Codacy detected in your repository, including the severity level and category of each issue.
3
+
The **Issues page** lists all the issues that Codacy detected in your repository, including the severity level and category of each issue.
4
4
5
5
By default, the page lists the issues on the main branch of your repository but if you have [more than one branch enabled](../repositories-configure/managing-branches.md) you can use the drop-down list at the top of the page to display issues on other branches.
Copy file name to clipboardExpand all lines: docs/repositories/pull-requests.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,9 +3,9 @@ page_name: "pull request"
3
3
file_name: "pull-requests"
4
4
---
5
5
6
-
# Quality Pull Requests page
6
+
# Pull Requests page
7
7
8
-
The **Quality Pull Requests page** displays an overview of the pull requests in your repository, such as the analysis status and the code quality metrics for each pull request. This allows you to monitor the code quality of the work in progress in your repository.
8
+
The **Pull Requests page** displays an overview of the pull requests in your repository, such as the analysis status and the code quality metrics for each pull request. This allows you to monitor the code quality of the work in progress in your repository.
9
9
10
10
By default, the page lists open pull requests, but you can click the **Closed** tab at the top of the list to display the closed pull requests.
0 commit comments