This documentation is a preview of the pull request #2301

For the latest updates and improvements in production, open docs.codacy.com instead.

Quality Issues page#

The Quality Issues page lists all the issues that Codacy detected in your repository, including the severity level and category of each issue.

By default, the page lists the issues on the main branch of your repository but if you have more than one branch enabled you can use the drop-down list at the top of the page to display issues on other branches.

Note

You can use the Codacy API to generate reports or obtain information about the current issues in your repositories in a more flexible way.

Issues page

Click the title of an issue card to expand it and see the following information:

The committer and date of the commit that introduced the issue, if available
The estimated time to fix the issue
What the issue is and how to solve it
The tool that reported the issue and the related code pattern
Where's this pattern enabled: coding standard, repository rules, or configuration file

Issue details

Filtering issues#

Filter the list of issues to find specific issues, such as the issues with the highest severity or security issues.

The list of code patterns with issues is always visible on the left side of the page. Click a code pattern to filter the list of issues by that pattern.

Filtering issues

You can moreover define one or more of the following filters:

Language: Programming language of the file where the issues were detected
Severity level: Potential impact of the issues:
- Critical (red): The most dangerous issues that you should prioritize fixing since they identify code that's susceptible to serious problems regarding security and compatibility
- Medium (yellow): You should check out these issues, as they're based on coding standards and conventions
- Minor (blue): The least critical issues, such as most code style issues
Issue category: One of the following types of issue:
- Code style: Code formatting and syntax problems, such as variable names style and enforcing the use of brackets and quotation marks
- 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
- Code complexity: High complexity methods and classes that should be refactored
- Performance: Code that can have performance problems
- Compatibility: Mainly for frontend code, compatibility problems across different browser versions
- Unused code: Unused variables and methods, code that can't be reached
- Security: Potential security vulnerabilities, including hard-coded passwords and keys (secret scanning), vulnerable dependencies (software composition analysis or SCA), and insecure code patterns (static application security testing or SAST). For more information, see the complete list of security issue categories
- Documentation: Methods and classes that don't have the correct comment annotations
- Best practice: Code that doesn't follow the recommended coding standards and best practices
- Comprehensibility: Code that can be difficult to understand and modify
Author: Commit author that introduced the issue on the code

Note

Each code pattern has a pre-defined severity level and at the moment Codacy doesn't support customizing that information.

Ignoring and managing issues#

Organization admins can manage access to this feature

Use the options in the menu of each issue to:

Ignore the issue and hide it from the list.

Codacy will no longer report the issue after the next analysis of your repository. For example, you can ignore issues that you disagree with because:
- Your team won't tackle the issues in the immediate future
- The issue isn't relevant in the specific context of your code
- The issue is a false positive
See how to restore ignored issues.

Tip

Organization admins can configure who is allowed to ignore issues.
Disable the code pattern that detected the issue.

Codacy will stop using that pattern after the next analysis of your repository, so be sure that you're no longer interested in identifying similar issues. To re-enable patterns use the Code patterns page.
Note
- If you're using a custom configuration file, you must manage patterns manually on your configuration file.
- If your repository is following an organization coding standard, disabling the code pattern causes the repository to stop following the coding standard. In this case, Codacy asks for your confirmation before accepting the changes and then copies the coding standard configurations to your repository, so you can customize them.
View the file where the issue was detected.
Ignore the file where the issue was detected.

Codacy will no longer analyze that file on your repository, so be sure that you're no longer interested in identifying any type of issues on that file. To remove an ignored file use the Ignored Files tab in your repository settings.

Restoring ignored issues#

To see the list of ignored issues, click the Ignored tab.

To restore an ignored issue, select Unignore issue from the options menu:

Restoring an ignored issue

Fixing issues automatically#

This section applies to GitHub repositories only

If Codacy detects code patterns with suggested fixes, a Fix issues button appears above the issue list.

In this case, Codacy generates a patch that enables you to solve all resolvable issues. To apply this patch to the default branch, do the following:

Click the button Fix issues to open a modal with a patch that addresses all resolvable issues.
Copy the patch content to the clipboard.
Create a new branch from the default branch.
Apply the patch from the repository's root directory, for example with the pbpaste | patch command.

Note

These changes are automatically generated. Review them to make sure they're correct.
Push the new branch to the repository.
On GitHub, create a pull request from the new branch to the default branch.

Quality Issues page#

Filtering issues#

Ignoring and managing issues#

Restoring ignored issues#

Fixing issues automatically#

See also#

Share your feedback 📢