From de011126c8c13b477fb5d5e477125a9619b6fc85 Mon Sep 17 00:00:00 2001 From: Alejandro Rizzo Date: Mon, 4 Nov 2024 13:25:08 +0000 Subject: [PATCH] docs: update with cross tool search and issues / kloc (#2252) --- .../code-analysis/which-metrics-does-codacy-calculate.md | 8 ++++---- docs/organizations/using-coding-standards.md | 1 + docs/repositories-configure/configuring-code-patterns.md | 9 +++++++++ 3 files changed, 14 insertions(+), 4 deletions(-) diff --git a/docs/faq/code-analysis/which-metrics-does-codacy-calculate.md b/docs/faq/code-analysis/which-metrics-does-codacy-calculate.md index 837ed900c9..0bf4c11d45 100644 --- a/docs/faq/code-analysis/which-metrics-does-codacy-calculate.md +++ b/docs/faq/code-analysis/which-metrics-does-codacy-calculate.md @@ -61,7 +61,7 @@ Codacy calculates the number of issues in the following static code analysis cat - **Comprehensibility:** Code that can be difficult to understand and modify -Besides this, Codacy also allows you to compare issues across repositories with different sizes by calculating the issue cost **relative to a baseline of 1 point per line of code**, where the cost of each issue depends on its severity: Critical = 10 points, Medium = 5 points, Minor = 1 point. This means that if your repository has 50% issues, the amount and severity of the issues in your repository is half of the baseline. +Besides this, Codacy also allows you to compare issues across repositories with different sizes by showing **issues per thousand lines of code (kLoC)**. Codacy displays issues on the following places: @@ -70,9 +70,9 @@ Codacy displays issues on the following places: |[Commit detail page](../../repositories/commits.md)
[Pull request detail page](../../repositories/pull-requests.md)
[Email notifications](../../account/emails.md#managing-your-email-notifications)|Number of new and fixed issues introduced by the commit or pull request| |[Files page](../../repositories/files.md)|Number of issues in each file| |[Issues page](../../repositories/issues.md)|List of all issues detected in each branch| -|[Repository Dashboard](../../repositories/repository-dashboard.md)|Issue percentage and how the metric is evolving over time| -|[Organization overview](../../organizations/organization-overview.md)|Average issue percentage of the repositories in your organization and issue percentage of each repository| -|[Repositories list page](../../organizations/managing-repositories.md)|Issue percentage in each repository in your organization| +|[Repository Dashboard](../../repositories/repository-dashboard.md)|Issues per 1000 lines of code| +|[Organization overview](../../organizations/organization-overview.md)|Average issues / kLoC of the repositories in your organization and issue / kLoC of each repository| +|[Repositories list page](../../organizations/managing-repositories.md)|Issues / kLoC in each repository in your organization| ## Complexity diff --git a/docs/organizations/using-coding-standards.md b/docs/organizations/using-coding-standards.md index 74d79c362c..310432176f 100644 --- a/docs/organizations/using-coding-standards.md +++ b/docs/organizations/using-coding-standards.md @@ -86,6 +86,7 @@ If you selected **Advanced setup** when [creating a new coding standard](#creati - Toggle the tools to run when Codacy analyzes your code. - For each enabled tool, configure the code patterns to use. + - You can also use the **Discover patterns** option to find patterns across all tools. !!! tip - Use the filters to find the relevant tools and code patterns. The recommended configurations are manually curated by Codacy or based on tool defaults and are marked with the icon ![Recommended icon](images/coding-standard-recommended-icon.png). diff --git a/docs/repositories-configure/configuring-code-patterns.md b/docs/repositories-configure/configuring-code-patterns.md index 1cb18cd09a..120fe42500 100644 --- a/docs/repositories-configure/configuring-code-patterns.md +++ b/docs/repositories-configure/configuring-code-patterns.md @@ -9,6 +9,7 @@ description: Configure the static analysis tools and code patterns that Codacy u By default, Codacy analyzes your repositories using a subset of the supported analysis tools and code patterns. These defaults are based on current best practices and community feedback, and you can adapt them to your needs as follows: - [Configuring tools and code patterns using the Codacy UI](#configuring-tools-and-code-patterns-using-the-codacy-ui) +- [Discover code patterns across all tools](#discover-code-patterns-across-all-tools) - [Customizing applied coding standards](#using-your-own-tool-configuration-files) - [Customizing patterns when following coding standards](#customizing-patterns-following-standards) - [Using tool configuration files](#using-your-own-tool-configuration-files) @@ -38,6 +39,14 @@ To configure the tools and code patterns for a repository using the Codacy UI: 1. Optionally, to take the changes into account immediately, [reanalyze the repository manually](../faq/repositories/how-do-i-reanalyze-my-repository.md). Otherwise, Codacy will use the updated configuration when analyzing new commits and pull requests. +## Discover code patterns across all tools {: id="discover-code-patterns-across-all-tools"} + +To discover code patterns across all tools, click **Discover patterns** at the top of the **Tools** list. + +Use the input field to search for patterns by name or description. You can also filter by severity level, issue category, recommended or disabled patterns. + +You can also expand your search to include patterns from all tools, even if the tool is not enabled for the repository. + ## Customizing applied coding standards {: id="customizing-applied-coding-standards"} To apply or edit a repository's [coding standards](../organizations/using-coding-standards.md), click **Customize** in the **Following ...** section at the top of the **Code patterns** page.