Skip to content
This documentation is a preview of the pull request #2253

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

Quality Files page#

The Quality Files page displays the current code quality information for each analyzed file in your enabled repository branches.

By default, the page lists the files on the main branch of your repository. However, if you have more than one branch enabled, you can select other branches using the drop-down list at the top of the page.

Codacy displays the following code quality metrics for each file, if available:

  • Grade: Overall grade of the file
  • Issues: Number of issues in the file
  • Complexity: Cyclomatic complexity of the file
  • Duplication: Number of duplicated code blocks in the file
  • Coverage: Percentage of coverable source lines of code that are covered by tests

Codacy displays the files in alphabetical order by default, but you can sort the list by each column to help you identify which files you should improve or refactor next.

Note

You can use the Codacy API to generate reports or obtain code quality metrics for the files in your repositories in a more flexible way.

Files list

Use the search box to filter the list and find specific files:

Finding specific files

File details#

Click a specific file to see more detailed analysis information for that file.

The header of the file detail page displays the same code quality metrics as the Files page, as well as:

  • An Ignore file link to ignore the selected file on future Codacy analysis
  • A link to view the file on your Git provider

File detail

Depending on the available analysis information for the file, Codacy displays one or more of the following tabs:

  • 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 for a file

  • Duplication: Shows the annotated source code on the left-hand side and the matching list of duplicated code blocks and counts on the right-hand side. Each listed duplicate includes the number of clones and their locations.

    Duplicated blocks for a file

  • Coverage: Shows which lines of code are covered by tests (green background labeled with test hit count) or not covered (red background), along with the counts of coverable and covered lines and the file status with respect to the coverage goal.

    Coverage information for a file

Why are some files missing?#

The Files page only displays files in your repository that were analyzed by Codacy. This means that some of your files may be missing from the list, for example:

  • You're viewing the incorrect branch

    Not all files may exist in all branches of your repositories. Make sure that you're displaying files for the correct branch.

  • The file might be ignored

    The Files page doesn't display ignored files that aren't meant to be analyzed, including the files that Codacy ignores by default.

  • The file has an extension that is not on the list of supported extensions

    Codacy supports a list of file extensions associated with each language. Codacy doesn't analyze or display files with extensions that aren't associated with a language.

  • The file might be too big

    Codacy doesn't analyze or display files that are over a certain size. Read more details for information on how to overcome this limit.

See also#

Share your feedback 📢

Did this page help you?

Thanks for the feedback! Is there anything else you'd like to tell us about this page?

We're sorry to hear that. Please let us know what we can improve:

Alternatively, you can create a more detailed issue on our GitHub repository.

Thanks for helping improve the Codacy documentation.

Edit this page on GitHub if you notice something wrong or missing.

If you have a question or need help please contact support@codacy.com.

Last modified July 2, 2024