Skip to content

Commit 5f51961

Browse files
committed
Update README, add more useful information
1 parent 42f402a commit 5f51961

File tree

1 file changed

+34
-20
lines changed

1 file changed

+34
-20
lines changed

README.md

Lines changed: 34 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
# SonarLint for Emacs
2+
![License: GPLv3](https://img.shields.io/badge/License-GPLv3-blue.svg)
3+
24

35
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.
46
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
1214
- [ht](https://github.com/Wilfred/ht.el)
1315
- [dash](https://github.com/magnars/dash.el)
1416

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+
1521

1622
## Installation
1723

@@ -67,10 +73,6 @@ The extension will check every plugin path and ask if it is not find to download
6773
the default path is defined in **lsp-sonarlint-LANGUAGENAME-analyzer-path**.
6874

6975

70-
71-
72-
73-
7476
## Static Analysis Rules
7577

7678
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
8587
- [Ruby rules](https://rules.sonarsource.com/ruby)
8688
- [XML rules](https://rules.sonarsource.com/xml)
8789

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
106+
* `lsp-sonarlint-LANGUAGE-repository-url` - Plugin source code
89107

90-
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.
91108

92-
To analyze JavaScript and TypeScript, SonarLint will also need Node.js.
93109

94110
## Data and telemetry
95111

96112
This extension collects anonymous usage data and sends it to SonarSource.
97113

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.
117+
118+
## Additional packages
99119

100-
## License
101-
lsp-sonarlint Copyright © 2020 by Fermin Munoz <[email protected]>
120+
* [lsp-ui](https://github.com/emacs-lsp/lsp-ui) : Flycheck, documentation and code actions support.
121+
* [company-lsp](https://github.com/tigersoldier/company-lsp) : LSP company backend.
122+
* [treemacs](https://github.com/Alexander-Miller/treemacs) : Project viewer.
123+
* [lsp-treemacs](https://github.com/emacs-lsp/lsp-treemacs) : `lsp-mode` GUI controls implemented using treemacs.
102124

103-
lsp-sonarlint is free software: you can redistribute it and/or modify
104-
it under the terms of the GNU General Public License as published by
105-
the Free Software Foundation, either version 3 of the License, or
106-
(at your option) any later version.
107125

108-
lsp-sonarlint is distributed in the hope that it will be useful,
109-
but WITHOUT ANY WARRANTY; without even the implied warranty of
110-
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
111-
GNU General Public License for more details.
126+
## Contributions
112127

113-
You should have received a copy of the GNU General Public License
114-
along with lsp-sonarlint. If not, see <http://www.gnu.org/licenses/>.
128+
Contributions are very much welcome.

0 commit comments

Comments
 (0)