You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
SonarLint is a free IDE extension that lets you fix coding issues before they exist! Like a spell checker, SonarLint highlights Bugs and Security Vulnerabilities as you write code, with clear remediation guidance so you can fix them before the code is even committed.
4
6
SonarLint in Emacs supports analysis of JavaScript, TypeScript, Python, Java, HTML , PHP, Ruby, Scala and XML out of the box!
@@ -12,6 +14,10 @@ SonarLint in Emacs supports analysis of JavaScript, TypeScript, Python, Java, HT
12
14
-[ht](https://github.com/Wilfred/ht.el)
13
15
-[dash](https://github.com/magnars/dash.el)
14
16
17
+
The SonarLint language server needs a Java Runtime (JRE) 8 or 11. If one is already installed on your computer, SonarLint should automatically find and use it.
18
+
19
+
To analyze JavaScript and TypeScript, SonarLint will also need Node.js.
20
+
15
21
16
22
## Installation
17
23
@@ -67,10 +73,6 @@ The extension will check every plugin path and ask if it is not find to download
67
73
the default path is defined in **lsp-sonarlint-LANGUAGENAME-analyzer-path**.
68
74
69
75
70
-
71
-
72
-
73
-
74
76
## Static Analysis Rules
75
77
76
78
Out of the box, SonarLint automatically checks your code against the following rules:
@@ -85,30 +87,42 @@ Out of the box, SonarLint automatically checks your code against the following r
85
87
-[Ruby rules](https://rules.sonarsource.com/ruby)
86
88
-[XML rules](https://rules.sonarsource.com/xml)
87
89
88
-
## Requirements
90
+
## Supported settings
91
+
92
+
*`lsp-sonarlint-server-path` - Path of the sonarlint jar executable file.
93
+
*`lsp-sonarlint-modes-enabled` - List of major modes where the lsp server will activate.
94
+
*`lsp-sonarlint-disable-telemetry` - Disable telemetry option (disabled by default).
95
+
*`lsp-sonarlint-test-file-pattern` - Regex to find test file, most rules are not evaluated on test files.
96
+
*`lsp-sonarlint-show-analyzer-logs` - Show analyzer logs.
97
+
*`lsp-sonarlint-server-download-url` - Sonarlint server download URL.
98
+
99
+
### Plugins supported settings
100
+
This settigns are common for all the language plugins.
101
+
102
+
*`lsp-sonarlint-LANGUAGE-enabled` - Enable LANGUAGE lsp-sonarlint plugin (disable by default)
103
+
*`lsp-sonarlint-LANGUAGE-download-url` - URL to download the LANGUAGE sonarlint plugin
104
+
*`lsp-sonarlint-LANGUAGE-analyzer-path` - Location where the plugin/anlyzer is located.
105
+
*`lsp-sonarlint-LANGUAGE-doc-url` - Sonarsource official plugin documentation
The SonarLint language server needs a Java Runtime (JRE) 8 or 11. If one is already installed on your computer, SonarLint should automatically find and use it.
91
108
92
-
To analyze JavaScript and TypeScript, SonarLint will also need Node.js.
93
109
94
110
## Data and telemetry
95
111
96
112
This extension collects anonymous usage data and sends it to SonarSource.
97
113
98
-
Collection of telemetry is controlled via the setting: `lsp-sonarlint-disable-telemetry`. Click [here](https://github.com/SonarSource/sonarlint-vscode/blob/master/telemetry-sample.md) to see a sample of the data that are collected.
114
+
Collection of telemetry is controlled via the setting: `lsp-sonarlint-disable-telemetry`, it is disable by default.
115
+
116
+
Click [here](https://github.com/SonarSource/sonarlint-vscode/blob/master/telemetry-sample.md) to see a sample of the data that are collected.
0 commit comments