Skip to content

Commit a817efd

Browse files
Merge branch 'master' of https://github.com/codacy/docs
2 parents d58d4be + c9b5dd7 commit a817efd

32 files changed

Lines changed: 237 additions & 54 deletions

.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,10 @@ tools/*.csv
2222

2323
#Ignore vscode AI rules
2424
.github/copilot-instructions.md
25+
26+
#Ignore cursor AI rules
27+
.cursor/rules/codacy.mdc
28+
29+
#Ignore vscode AI rules
30+
.github/instructions/codacy.instructions.md
31+
-28 KB
Loading
-16.9 KB
Loading
-44.4 KB
Loading

docs/codacy-guardrails/codacy-guardrails-getting-started.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,7 @@ Besides real-time AI code scanning, Guardrails users can now prompt all their Co
4343
- PMD
4444
- dartanalyzer
4545
- [Lizard](https://docs.codacy.com/release-notes/cloud/cloud-2025-02-adding-ruff-lizard/#lizard)
46+
- Revive
4647

4748
## How to install - Quick Guide {: id="how-to-install-quick-guide"}
4849

docs/codacy-guardrails/codacy-guardrails-troubleshooting.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,4 +23,12 @@ npm install -g @codacy/codacy-mcp
2323
}
2424
}
2525
}
26-
```
26+
```
27+
28+
## GitHub Copilot
29+
30+
### MCP Policy Requirement
31+
32+
If Copilot doesn't find any MCP servers or tools, you might be missing the required policy setting. If you are a member of an organization or enterprise with a Copilot Business or Copilot Enterprise plan, the "MCP servers in Copilot" policy must be enabled in order to use MCP with Copilot. This policy can be configured by organization owners in the Copilot settings.
33+
34+
For more information about enabling this policy, see the [GitHub documentation on MCP prerequisites](https://docs.github.com/en/copilot/how-tos/provide-context/use-mcp/extend-copilot-chat-with-mcp#prerequisites).
-14.7 KB
Loading

docs/faq/code-analysis/which-metrics-does-codacy-calculate.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,13 @@ Codacy performs static code analysis and calculates code duplication, code compl
88

99
The following sections describe how Codacy calculates each supported metric and where you can see each metric on the Codacy UI:
1010

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)
1618

1719
!!! note
1820
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.
@@ -51,7 +53,7 @@ Codacy calculates the number of issues in the following static code analysis cat
5153
<!--issue-categories-start-->
5254
- **Code style:** Code formatting and syntax problems, such as variable names style and enforcing the use of brackets and quotation marks
5355
- **Error prone:** Code that may hide bugs and language keywords that should be used with caution, such as the operator `==` in JavaScript or `Option.get` in Scala
54-
- **Code complexity:** High complexity methods and classes that should be refactored
56+
- **Code complexity:** High complexity files that should be refactored
5557
- **Performance:** Code that can have performance problems
5658
- **Compatibility:** Mainly for frontend code, compatibility problems across different browser versions
5759
- **Unused code:** Unused variables and methods, code that can't be reached
@@ -88,8 +90,8 @@ Codacy displays complexity on the following places:
8890

8991
|Place|Metric|
9092
|-----|------|
91-
|[Commit detail page](../../repositories/commits.md)<br/>[Pull request detail page](../../repositories/pull-requests.md)<br/>[Email notifications](../../account/emails.md#managing-your-email-notifications)|Variation of the complexity value introduced by the commit or pull request|
92-
|[Files page](../../repositories/files.md)|Complexity value of each file|
93+
|[Commit detail page](../../repositories/commits.md)<br/>[Pull request detail page](../../repositories/pull-requests.md)<br/>[Email notifications](../../account/emails.md#managing-your-email-notifications)|The complexity variation introduced by a commit or pull request is defined as the sum of the changes in code complexity for each file modified in the commit or pull request|
94+
|[Files page](../../repositories/files.md)|The file complexity value is the sum of the complexity values of all methods defined within the file|
9395
|[Repository Dashboard](../../repositories/repository-dashboard.md)|Percentage of complex files in your repository and how the metric is evolving over time|
9496
|[Organization overview](../../organizations/organization-overview.md)|Average percentage of complex files in the repositories in your organization and percentage of complex files in each repository|
9597
|[Repositories list page](../../organizations/managing-repositories.md)|Percentage of complex files in each repository in your organization|

docs/getting-started/integrating-codacy-with-intellij-ides.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Integrating Codacy with IntelliJ IDEs
22

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.
44

55
!!! info "To use this plugin you need a [Codacy account](https://www.codacy.com/signup-codacy)"
66

@@ -12,15 +12,15 @@ The main view of the Codacy IntelliJ plugin provides a summary of the code quali
1212

1313
In the main view, you can find the following information:
1414

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.
1616

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.
1818

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.
2020

2121
- The **diff coverage** introduced by the pull request. The percentage next to each file name is the coverage variation for that file.
2222

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.
2424

2525
- Variations in **code complexity** introduced by the pull request.
2626

@@ -56,12 +56,12 @@ After completing these steps, the main view shows the result of the latest Codac
5656

5757
## Reviewing pull request issues
5858

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.
6060

6161
!!! note
6262
Code coverage, duplicates, and complexity aren't currently shown in the Problems tool window.
6363

64-
To review Quality issues:
64+
To review issues:
6565

6666
1. Open the file you want to review.
6767

docs/getting-started/integrating-codacy-with-visual-studio-code.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
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.
44

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.
66

77
!!! info "To use this extension you need a [Codacy account](https://www.codacy.com/signup-codacy)"
88

@@ -20,11 +20,11 @@ The main view of the extension displays information about the code quality and c
2020

2121
The **Pull request status** tab displays the following information for the pull request of the currently checked-out branch:
2222

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.
2424

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.
2626

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).
2828

2929
![Important issues](./images/codacy-vscode-extension-important-issues.png)
3030

@@ -34,7 +34,7 @@ The **Pull request status** tab displays the following information for the pull
3434

3535
![Toggle inline coverage](./images/codacy-vscode-extension-inline-coverage.png)
3636

37-
- 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.
3838

3939
- Variations in **code complexity** introduced by the pull request.
4040

@@ -48,23 +48,23 @@ The **Open Pull Requests** tab lists all open pull requests for the repository,
4848

4949
- Analyzing, if Codacy is analyzing the branch.
5050

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.
5252

5353
- The author of the pull request.
5454

5555
- The source and target branches of the pull request.
5656

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.
5858

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.
6060

6161
- 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.
6262

6363
### Analyzed branch tab
6464

6565
![Analyzed branch tab UI](images/codacy-vscode-extension-analyzed-branch-tab.png)
6666

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 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.
6868

6969
See [how to manage the analysis of your repository's branches](../repositories-configure/managing-branches.md).
7070

@@ -99,16 +99,16 @@ To see Codacy quality and coverage data for an open pull request, follow these s
9999

100100
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.
101101

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.
103103

104104
## Reviewing pull request issues
105105

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.
107107

108108
!!! note
109109
Code coverage, duplicates, and complexity aren't currently shown in the Problems tab.
110110

111-
To review Quality issues:
111+
To review issues:
112112

113113
1. Open the **Problems tab** (use `Ctrl+Shift+M` on Windows/Linux or `Cmd+Shift+M` on macOS).
114114

0 commit comments

Comments
 (0)