SonarLint for Atom.io
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
images
lib
.gitignore
.travis.yml
CHANGELOG.md
LICENSE.txt
README.md
develop.md
gulpfile.js
package-lock.json
package.json

README.md

SonarLint for Atom

SonarLint is an IDE extension that helps you detect and fix quality issues as you write code in JavaScript, TypeScript, PHP and Python.

How it works

SonarLint is an IDE extension that helps you detect and fix quality issues as you write code. Like a spell checker, SonarLint squiggles flaws so that they can be fixed before committing code. You can get it directly from the ATOM Marketplace, and it will then detect new bugs and quality issues as you code (JavaScript, TypeScript, PHP and Python).

sonarlint on-the-fly

Issues are highlighted in your code, and also listed in the 'Diagnostics' or 'Linter' panel. Note that only files within a project are analyzed. You can access the detailed rule description directly from your editor by using, depending on the UI tools you have, the provided code action or the link to the rules website.

Rules

Check the rules to see what SonarLint can do for you:

You will benefit from the following code analyzers: SonarJS, SonarTS, SonarPython and SonarPHP.

Requirements

  • SonarLint for Atom uses the language server protocol and relies on some packages to display the list of errors and highlight issues in the code. It works best with Atom IDE which is automatically proposed. But you can also use other compatible packages such as Linter and Nuclide.

  • You also need a Java Runtime (JRE) 8 installed on your computer. SonarLint should automatically find it but you can also explicitly set the path where the JRE is installed using the 'sonarlint.javaHome' variable in Atom settings (~/.atom/config.cson). For example:

    "*":
      sonarlint:
        javaHome: "C:\Program Files\Java\jre1.8.0_131"

Contributions and license

SonarLint for Atom is open source under the LGPL v3 license. Feel free to submit Pull Requests.

Feedback

The preferred way to discuss about SonarLint is by posting on the SonarSource Community Forum. Feel free to ask questions, report issues, and give suggestions.