Skip to content

Commit e3f2168

Browse files
committed
2 parents d2c0ffe + e0a27c0 commit e3f2168

File tree

2 files changed

+21
-9
lines changed

2 files changed

+21
-9
lines changed

README.md

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
# SonarLint for Emacs
22
![License: GPLv3](https://img.shields.io/badge/License-GPLv3-blue.svg)
3+
[![MELPA](https://melpa.org/packages/lsp-sonarlint-badge.svg)](https://melpa.org/#/lsp-sonarlint)
34
<a href="https://www.sonarlint.org/"> <img align="right" width="120" src="./images/SonarLint_icon.svg"></a>
45

56

6-
SonarLint is a free IDE extension that lets you fix coding issues before they exist!
77

8-
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.
8+
SonarLint™ is a free IDE extension that lets you fix coding issues before they exist!
99

10-
SonarLint in Emacs supports analysis of JavaScript, TypeScript, Python, Java, HTML , PHP, Ruby, Scala and XML out of the box!
10+
Like a spell checker,it highlights Bugs and Security Vulnerabilities as you write code, with clear remediation guidance so you can fix them before the code is even committed.
11+
12+
In Emacs supports analysis of JavaScript, TypeScript, Python, Java, HTML , PHP, Ruby, Scala and XML out of the box!
1113

1214
:warning: This is not an official [SonarSource](https://www.sonarsource.com/) extension
1315

@@ -19,7 +21,7 @@ SonarLint in Emacs supports analysis of JavaScript, TypeScript, Python, Java, HT
1921
- [ht](https://github.com/Wilfred/ht.el)
2022
- [dash](https://github.com/magnars/dash.el)
2123

22-
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.
24+
The 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.
2325

2426
To analyze JavaScript and TypeScript, SonarLint will also need Node.js.
2527

@@ -30,10 +32,15 @@ To analyze JavaScript and TypeScript, SonarLint will also need Node.js.
3032
Download and include the main file lsp-sonarlint.el and the folders languages and server.
3133

3234
### Melpa
33-
WIP
35+
You can then run the following commands to install lsp-sonarlint:
36+
37+
```
38+
M-x package-refresh-contents RET (to refresh your package database)
39+
M-x package-install RET lsp-sonarlint RET (to install and compile `lsp-sonarlint` and its dependencies)
40+
```
3441

3542
## Usage
36-
Sonarlint language server relies on java plugins to properly analyze the selected language source code.
43+
The language server relies on java plugins to properly analyze the selected language source code.
3744
The basic workflow to activate a plugin for a language is:
3845

3946
- Enable language specific extension, alongside lsp-sonarlint:
@@ -123,11 +130,16 @@ Click [here](https://github.com/SonarSource/sonarlint-vscode/blob/master/telemet
123130
## Additional packages
124131

125132
* [lsp-ui](https://github.com/emacs-lsp/lsp-ui) : Flycheck, documentation and code actions support.
126-
* [company-lsp](https://github.com/tigersoldier/company-lsp) : LSP company backend.
133+
* [company-capf](https://github.com/company-mode/company-mode) : Completion backend support.
127134
* [treemacs](https://github.com/Alexander-Miller/treemacs) : Project viewer.
128135
* [lsp-treemacs](https://github.com/emacs-lsp/lsp-treemacs) : `lsp-mode` GUI controls implemented using treemacs.
129136

130137

131138
## Contributions
132139

133140
Contributions are very much welcome.
141+
142+
#### Copyright
143+
144+
SONARLINT and SONARSOURCE are trademarks of SonarSource SA.
145+
All other trademarks and copyrights are the property of their respective owners.

lsp-sonarlint.el

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
;; Created: 13 Jun 2020
77
;; Version: 0.0.1
88
;; Keywords: languages, tools, php, javascript, xml, ruby, html, scala, java, python
9-
;; URL: https://gitlab.com/sasanidas/lsp-sonarlint
9+
;; URL: https://github.com/emacs-lsp/lsp-sonarlint
1010
;; Package-Requires: ((emacs "25") (dash "2.12.0") (lsp-mode "6.3") (ht "2.3"))
1111
;; License: GPL-3.0-or-later
1212

@@ -41,7 +41,7 @@
4141
(defgroup lsp-sonarlint nil
4242
"Sonarlint lsp server group"
4343
:group 'lsp-mode
44-
:link '(url-link "https://gitlab.com/sasanidas/lsp-sonarlint")
44+
:link '(url-link "https://github.com/emacs-lsp/lsp-sonarlint")
4545
:package-version '(lsp-mode . "6.4"))
4646

4747
(defcustom lsp-sonarlint-server-path

0 commit comments

Comments
 (0)