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 they can be fixed before committing code.
- SonarLint website
- Features
- List of static code analysis rules per language:
- SonarLint community
You can install SonarLint from the IntelliJ IDEA Plugin Repository, directly available in IntelliJ preferences.
For SonarLint support questions ("How do I?", "I got this error, why?", ...), please first read the FAQ and then head to the SonarSource forum. There are chances that a question similar to yours has already been answered.
Be aware that this forum is a community, so the standard pleasantries ("Hi", "Thanks", ...) are expected. And if you don't get an answer to your thread, you should sit on your hands for at least three days before bumping it. Operators are not standing by. :-)
If you would like to see a new feature, please create a new thread in the forum "Suggest new features".
Please be aware that we are not actively looking for feature contributions. The truth is that it's extremely difficult for someone outside SonarSource to comply with our roadmap and expectations. Therefore, we typically only accept minor cosmetic changes and typo fixes.
With that in mind, if you would like to submit a code contribution, please create a pull request for this repository. Please explain your motives to contribute this change: what problem you are trying to fix, what improvement you are trying to make.
Make sure that you follow our code style and all tests are passing.
./gradlew buildPlugin
Note that the above won't run tests and checks. To do that too, run:
./gradlew check buildPlugin
For the complete list of tasks, see:
./gradlew tasks
Import the project as a Gradle project.
Note: whenever you change a Gradle setting (for example in build.gradle),
don't forget to Refresh all Gradle projects in the Gradle toolbar.
To run an IntelliJ instance with the plugin installed, execute the Gradle task runIde using the command line,
or the Gradle toolbar in IntelliJ, under Tasks/intellij.
The instance files are stored under build/idea-sandbox.
Keep in mind that the clean task will wipe out the content of build/idea-sandbox,
so you will need to repeat some setup steps for that instance, such as configuring the JDK.
Whenever you change dependency version, the previous versions are not deleted from the sandbox, and the JVM might not load the version that you expect.
As the clean task may be inconvenient, an easier workaround is to delete the jars in the sandbox, for example with:
find build/idea-sandbox/ -name '*.jar' -delete
./gradlew release
Deploy on Jetbrains plugin repository (todo try to use publish task).
Copyright 2015-2020 SonarSource.
Licensed under the GNU Lesser General Public License, Version 3.0