Skip to content

Commit

Permalink
Fix the README
Browse files Browse the repository at this point in the history
  • Loading branch information
tiulpin committed Sep 28, 2023
1 parent d7d88e9 commit 248fdb7
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 26 deletions.
50 changes: 25 additions & 25 deletions vscode/qodana/README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@
# Qodana VSCode extension
[![GitHub Discussions](https://img.shields.io/github/discussions/jetbrains/qodana)]
[![Twitter Follow](https://img.shields.io/twitter/follow/Qodana?style=social&logo=twitter)]
# Qodana for Visual Studio Code extension

[![GitHub Discussions](https://img.shields.io/github/discussions/jetbrains/qodana)](https://github.com/JetBrains/Qodana/discussions/)
[![Twitter Follow](https://img.shields.io/twitter/follow/Qodana?style=social&logo=twitter)](https://twitter.com/Qodana)

This extension connects to Qodana Cloud and showcases the latest code quality issues for your project.

## Prerequisites

Before utilizing the extension, please ensure you fulfill the following prerequisites:

1. You have a Qodana Cloud account. If not, please create one [here](https://qodana.cloud/).
2. You have a project set up on Qodana Cloud. If not, please create one [here](https://qodana.cloud/).
3. The source code of this project has been downloaded to your local machine and is opened in a VS Code workspace
4. You have run the Qodana analysis for your project at least once and generated a report in your Qodana Cloud project.
5. There is a Java binary on your system path (JRE 11 or higher is required). You can check it by running the command "java -version" in the Terminal.

## Installation and Configuration

1. Open your project as a Workspace in VS Code, make sure your VS Code window is a top most among other VS Code windows.
2. Open Qodana Cloud, navigate to your project and click "Open in VSCode" button from the dropdown selector under any issue found in the project.
3. You will be prompted to authenticate with Qodana Cloud. Once authorized, the extension will be set and ready for use.
Expand All @@ -30,20 +30,20 @@ If you don't see any issues from the report after successfully loading it, adjus
The rule is: `"Full Path" = "Workspace" + "Path Prefix" + "Path in SARIF"`

Here are examples how to define the correct path prefix:
| Full Path | Path in SARIF | Workspace | Path Prefix |
|-------------------|------------------|------------------|------------------|
| /foo/bar/baz/file | baz/file | /foo/bar | (empty, no value)|
| /foo/bar/baz/file | baz/file | /foo/bar/baz | .. |
| /foo/bar/baz/file | file | /foo/bar | baz |

| Full Path | Path in SARIF | Workspace | Path Prefix |
|-------------------|---------------|--------------|-------------------|
| /foo/bar/baz/file | baz/file | /foo/bar | (empty, no value) |
| /foo/bar/baz/file | baz/file | /foo/bar/baz | .. |
| /foo/bar/baz/file | file | /foo/bar | baz |

You can refer to the Qodana Cloud report (within the Files section beneath the sunburst diagram) to see how the "Path in SARIF" is set.


## Usage

Once the project is set up, it will synchronize with Qodana Cloud. If there are any issues found by Qodana analysis, they will be displayed in the file list and under the Problems view (View > Problems).

To stop receiving new reports from Qodana Cloud, use the command `Qodana: Reset authentication`.
To reset the extension settings, use the command `Qodana: Reset settings`.
To temporarily disable the extension, click on Qodana item in the status bar, so that it turns yellow.
Expand Down Expand Up @@ -72,13 +72,13 @@ Respecting your privacy, we provide the option to opt-out of telemetry data coll

This information helps us understand your needs better to enhance the functionality and user experience of the Qodana Cloud VS Code extension, while keeping your data private and secure. Your feedback is always appreciated!


## Questions, issues, or feedback?

All issues, feature requests, and support inquiries related to Qodana are managed at: [YouTrack][youtrack].

To file a new issue, please follow this link: [YouTrack | New Issue][youtrack-new-issue]. Additionally, you can use [GitHub Discussions][jb:discussions] to pose questions or provide feedback.

[gh:qodana]: https://github.com/JetBrains/qodana-action/actions/workflows/code_scanning.yml
[youtrack]: https://youtrack.jetbrains.com/issues/QD
[youtrack-new-issue]: https://youtrack.jetbrains.com/newIssue?project=QD&c=Platform%20GitHub%20action
Expand Down
2 changes: 1 addition & 1 deletion vscode/qodana/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
"icon": "plugin-icon.png",
"repository": {
"type": "git",
"url": "ssh://git@github.com:qodana/qodana-lsp.git"
"url": "ssh://git@github.com:JetBrains/qodana-lsp.git"
},
"engines": {
"vscode": "^1.81.0"
Expand Down

0 comments on commit 248fdb7

Please sign in to comment.