Here you get an overview of all issues raised by Codacy in your project. We arrange them in six categories. For every issue, we present information on why is this an issue, how you could solve it, and the related code pattern.
The Issues View
An issue expanded
1. Issue Categories
- Security: security issues, potential vulnerabilities, unsafe dependencies.
- Error Prone: bad practices/patterns that cause code to fail/prone to bugs.
- Code Style: related to the style of the code, line length, tabs vs spaces.
- Compatibility: identifies code that has problems with older systems or cross platform support.
- Unused Code: unnecessary code not being used.
- Performance: inefficiently written code.
2. Ignoring an issue
For an issue you disagree with or false positives, you can either ignore that instance or disable the pattern across the whole project. To do so, click on and select the desired option.
2.1. Reinstating ignored issues
To reinstate ignored issues, click on the Current Issues box, and select Ignored Issues from the drop-down menu.
3. Removing a pattern
When you want to remove a pattern altogether from your project’s analysis, expand the issue you’re aiming to disable the pattern for, click on, select Remove pattern and confirm your choice.
Note that if you’re using a custom pattern configuration file, have to remove the line manually.
3.1. Restoring a removed pattern
To restore a removed pattern, go to your project’s Code Pattern settings, choose the tool you’d like to enable the pattern for, find the pattern and click on the check box to enable.
Note that if you’re using a custom pattern configuration file, have to restore the line manually.
4. Ignoring files
You can cherry-pick files to be ignored for further analysis. To ignore a file, expand the issue, click on, select Ignore file from the menu, and confirm. WARNING: This file is now ignored across the entire project and for all patterns.
4.1. Managing ignored files
Ignored files are managed through Settings>Ignore Files.
For more information on this topic, have a look at this article.
5. Create a Comment (GitHub)
You can add comments to the code on Codacy, and it will sync in your repository on GitHub.
For GitHub integration and usage of this feature, please read our article on GitHub integration.