Project

All of your project quality status and settings.

Introduction

Project in DeepScan corresponds to a GitHub or GitLab repository.

Basic layout of the project page is divided into the below:

  • Team Name: Select and navigate to the team
  • Project Name: The name of the project. It consists of <user name>/<repository name>.
  • Overview, Issues, Files, and Settings views
  • GitHub or GitLab: Go to the GitHub repository or the GitLab project

Project

Overview

You can see an overall status of the project by the branch.

Summary Issues
  • Grade The grade representing status on the project. In the below, you can see the remaining issues to a Good grade.
  • Lines of Code The count of source lines in the file (excluding empty lines, white space lines, comment lines and <style> in the Vue template)
  • Total lines The count of raw lines in the file
  • Analyzed Files The number of files to be analyzed
  • Unresolved Issues The number of non-resolved issues in the project
  • New since previous The number of newly-detected issues since the last analysis
  • Fixed The number of resolved issues in the project

Branch

You can see analyzed and non-analyzed branches of the project and switch between branches.

Badge

Badge lets you share the status to the communities or organizations you belong to.

To add a badge to your project, copy and paste Markdown or HTML into your repository's README file.

Note: The default file type of a badge is SVG. When you can't use it due to security concerns, you can use PNG. Just replace .svg in the url with .png.

Share

Share your result with your friends via email.

Commit Message and Last Analyzed

On the left side, you can see the latest commit message of the repository.

On the right side, you can see the last analyzed time of the project.

Issues

Trends

You can see how your project has changed over time.

Trends chart tracks the number of unresolved issues over time. Each line represents the count by high, medium, low-impact and total respectively.

When hovering over a dot in the line, you can see the number of issues.

Issue Trends

Impacts

You can directly see the number of issues by impacts (high, medium, and low) so you get to know which severity of problems are involved in your project.

Categories

You can directly see the number of issues by category (Error and Code Quality) so you get to know which type of problems are involved in your project.

Issues

Information about the issues in the project.

  • Get a list of all issues.
  • View a small code snippet for each issue. We display a code snippet in above 3 lines and below 1 line around the line where an issue is detected.
  • Sort and filter issues.

Files

Information about the files in the project.

  • Get a list of all analyzed files.
  • View issues for each file.
  • View file and download it.

Settings

You can configure the project to your preferences.

  • Configure rules. You can select or deselect the rules to apply project analysis. For configuration changes to take effect, you need to reanalyze.
  • Configure patterns to exclude files or directories from the analysis.
  • Enable ESLint and set merge option for identical issues detected by both of ESLint and DeepScan engine.
  • Control how the commit status of pull request is set by the detected issues' priority.
  • Delete project.
Last updated on September 27, 2024