Sonarqube and their Documentation - Part 1

in programming •  7 years ago 

So as I said in my first post at the time I am currently working on a Plugin for Sonarqube, so I thought I might as well write a bit about it.

What the hell is Sonarqube?

Sonarqube is a nice little tool to check automatically check your code for codingconventions and possible problems that might arise from your program. It's running on a server and you just (for example in Maven) upload your project automatically if building it. I really enjoy instantly seeing where my code is bad. You can even configure it to your choosing and they have a nice marketplace which makes it really convenient to install new plugins.
But now I wanted to program my own plugin for it to check files with an .file extension to really be able to test everything in the code.

The Documentation is literally hell

So for the start I decided to do a step by step guide from Sonarqube to get started with the framework (for whom might want to try it four themself I used Writing Custom Java Rules 101 by Michael Gumowski)
The Author of this Tutorial really made it quiet easy to understand and put some effort into writting it however the Tutorial and the github Project are broken. It was really frustrating following the step by step guide and finding out that some of the used libaries are outdated thankfully I found a elegant solution. But it didn't stop there. As soon as I put the plugin on the Server the whole server crashed on me. So I had to spend more time going throu the logs and trying to figure out what happened. As a first timer with this tool only having a small grasp on how it works this was quiet tedious.

I know im interrupting my blog a bit abrupt but I will talk finish it in Part 2. For whom might wonder why I'm not going into detail at the time beeing I'm working on my own tutorial. Hopefully I will be able to share it soon. If you have any questions don't shy away from commenting or sending me a message.

Authors get paid when people like you upvote their post.
If you enjoyed what you read here, create your account today and start earning FREE STEEM!