New plugin to analyse source code against English grammar

[Izzet Mustafaiev]

Hi guys,

There is a new plugin was implemented to analyse source code against English grammar. The idea is quite simple - read code and check for grammar using built-in dictionary with capabilities to extend dictionary through plugin settings in SonarQube admin console.

A version can be downloaded at https://dl.bintray.com/webdizz/sonarqube-plugins/. It is compatible with SonarQube 5.1+. The source code is available at https://github.com/webdizz/sonarqube-grammar.

Feel free to give it a try. Any feedback is more than welcome!

@SonarSource: It would be great if you would be able to give it a try and provide some feedback. If you find it valuable, I would be happy to have it hosted at https://github.com/SonarCommunity 

Many thanks!

[Izzet Mustafaiev]

Dear @SonarSource any feedback on this?

Thanks

[Michał Kordas]

Hi Izzet,

Generally idea is great, +1 from me.

I've added this plugin to my analysis, but I get tremendous amount of violations (300K on pretty small project). It's because plugin does not recognize words that are commonly used in code like:

• aop
• jmx
• sql
• xquery

It also raises violations on correct English words, I think you should use better dictionary:

• reportability
  
• monitorable

Also, plugin should not raise any violations in import lines - right now I'm getting exceptions like:

I'm even getting violations on calls to standard Java functions:

Also, I don't think that plugin validates any grammar - it just checks typos, right?

Thanks,

Michal

[Izzet Mustafaiev]

Michal,

Thanks for your feedback. Will apply your suggestions if possible.

[thomas....@gmail.com]

Hello Izzet,

I also like your idea.

It would be great to have a central dictionary server to offer the dictionary including the custom word list. It a hassle to maintain 20 seperate dictionaries on my machine (some exmaples: libre office, netbeans, chromium ...). I know this might be bigger which is not clearly a part of the plugin. But maybe you can start this approach.

Best regards,

Thomas

[Izzet Mustafaiev]

Thomas,

Thanks for feedback.

Actually you do not need to maintain different dictionaries. There are 2 of them, one is built-in and delivered with plugin installation, the second one could be configured through plugin settings page where you can add new words, also this alternative dictionary could be populated directly from issues page - there is an action to add misspelled word.

As for central dictionary I'm started to think about dedicated Github repository with one dictionary file, this way everybody could fork it and configure to use it, and plugin will manage to use it. What do you think?

Regards

[Simon Brandhof]

Hi Izzet,

Intellij has the same feature and it's very useful, so this plugin is a good idea. By the way it will allow to detect this typo in the plugin itself :-)

If I correctly understand only Java codebase is supported. That deserves to be documented. Moreover the plugin is not implemented as an extension of the Java plugin. It parses and tokenizes sources independently. That means that dealing with the false-positives raised by Michal can be tricky to resolve (ignore imports, ...). What's your feeling about that ? Moreover how could it support other languages ?

Thanks

Simon BRANDHOF | SonarSource

Tech Lead & Co-Founder
http://twitter.com/SimonBrandhof

--
You received this message because you are subscribed to the Google Groups "SonarQube" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sonarqube+...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/sonarqube/49b0f524-32c4-4df6-90ae-9eeb9f96139f%40googlegroups.com.

For more options, visit https://groups.google.com/d/optout.

[Izzet Mustafaiev]

Hi Simon,

Thanks for your feedback.

On Wednesday, September 9, 2015 at 12:46:58 PM UTC+3, Simon Brandhof wrote:

Hi Izzet,

Intellij has the same feature and it's very useful, so this plugin is a good idea. By the way it will allow to detect this typo in the plugin itself :-)

Actually IntelliJ was a source of this idea, as many developers do not use it and other IDEs/editors do not support this feature, so SonarQube is a good tool to keep code clean so why not to have it to keep code clean from spelling point of view. Right, it detects such issues and there a re a lot of them introduced for this purpose :) 

If I correctly understand only Java codebase is supported. That deserves to be documented.

You're right Java is the only language for now, there is a note in README for that. 

Moreover the plugin is not implemented as an extension of the Java plugin. It parses and tokenizes sources independently. That means that dealing with the false-positives raised by Michal can be tricky to resolve (ignore imports, ...). What's your feeling about that ? Moreover how could it support other languages ?

Well, to be honest  I do not know how to make it an extension of Java plugin. And yes, the support of other languages is part of this plugin as not only Java developers have problems with spelling J. That said other languages considered to be supported in next releases.

[Izzet Mustafaiev]

According to suggestion plugin name was changed to sonarqube-spellcheck and source code is available here https://github.com/webdizz/sonarqube-spellcheck, remaining related changes will be provided.

On Monday, September 7, 2015 at 11:27:58 AM UTC+3, Izzet Mustafaiev wrote:

[Izzet Mustafaiev]

Hi Simon,

Could you help with adding plugin to the list? Or please specify what should be changed if any in order to have it in the list?

Thanks,

Izzet

On Wednesday, September 9, 2015 at 12:46:58 PM UTC+3, Simon Brandhof wrote:

[G. Ann Campbell]

I've added it to the Community Plugins page: http://docs.sonarqube.org/display/PLUG/Community+Plugins

[Izzet Mustafaiev]

Thanks, will it appear in SonarQube update center?

Thanks

[G. Ann Campbell]

As far as I can tell, it's not eligible yet: http://docs.sonarqube.org/display/DEV/Your+Plugin+in+SonarQube+Update+Center

---

G. Ann CAMPBELL | SonarSource

Product Owner

http://sonarsource.com

--
You received this message because you are subscribed to a topic in the Google Groups "SonarQube" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/sonarqube/uhI076uh3jM/unsubscribe.
To unsubscribe from this group and all its topics, send an email to sonarqube+...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/sonarqube/15c0ee7d-26f2-4151-9015-44d758b190e7%40googlegroups.com.

[Izzet Mustafaiev]

G. Ann Campbell,

Thanks for reply.

Could we go by points so that I can clearly understand what is outstanding and to have confirmation?

• Your plugin is open-source [IM] As for me with this item there is a full compliance 
  • Source is freely accessible
  • The license is a known FLOSS one (check the list provided by the Open Source Initiative)
  • There's a public issue tracking system
  • Documentation is available online
  • Binaries of each version are accessible somewhere
• For each release the following must be available: [IM] Looks like need to utilise Github/Bintray release capabilities
  • release notes
  • plugin jar
• The description of your plugin must not be misleading in terms of content (the code needs to do pretty much what the name and description say it does) [IM] Looks like fully compliant
• Your plugin does not compete with existing SonarSource products (sorry, but we gotta pay the bills somehow) [IM] Looks like fully compliant
• It is analysed on Nemo and the quality gate is green when doing a release [IM] Could plugin be added to Nemo?
  • Initial configuration must be requested on the SonarQube Google Group
• Last but not least: your plugin must be aligned with the goal of the SonarQube platform: management of the technical debt and the quality of the code [IM] Looks like fully compliant
  • To be more precise: every feature of SonarQube is tied to the code, so if your plugin provides data that can't be attached to a source or a test file, then there are chances that your plugin won't be accepted in the Update Center

Thanks for your help

[G. Ann Campbell]

Indeed, you have no releases, that I can see, and it's not analyzed on Nemo. I'll add it to Nemo "soon" and we can go from there.

---

G. Ann CAMPBELL | SonarSource

Product Owner

http://sonarsource.com

To view this discussion on the web visit https://groups.google.com/d/msgid/sonarqube/fd937531-2a46-4102-9146-b162e08d4e7b%40googlegroups.com.

[Izzet Mustafaiev]

Thanks, will provide a release.

[G. Ann Campbell]

Here's your Nemo analysis: http://nemo.sonarqube.org/dashboard/index/com.epam.sonarqube:sonarqube-spellcheck-plugin

---

G. Ann CAMPBELL | SonarSource

Product Owner

http://sonarsource.com

To view this discussion on the web visit https://groups.google.com/d/msgid/sonarqube/44a592c7-53ed-4d62-ad2e-e3fef40f5ba0%40googlegroups.com.

[Izzet Mustafaiev]

Thanks a lot.

[Izzet Mustafaiev]

G. Ann CAMPBELL,

We made a progress with fixing of issues and plugin source code is above quality gate.

Also here is a release notes of the first GA https://github.com/webdizz/sonarqube-spellcheck/blob/master/RELEASE_NOTES.md.

Could you please tell what is a process of release to become available in market?

Thanks

[Izzet Mustafaiev]

Ann,

Here is a new release with bug fixes and improvements https://github.com/webdizz/sonarqube-spellcheck/releases/tag/0.1.1.GA.

Could you please promote it to be available for installation from "Update Center"?

Thanks,

Izzet

[G. Ann Campbell]

Hi Izzet,

I don't remember seeing the vote for this version. Could you point the thread out to me?

Also, I'm confused by this ticket in the release: 

• #34 Remove misspelling metric

Rather than removing the metric, you appear to have populated it...? Somehow I can no longer add it as a components column, but it still shows up in the Measures interface:

Populate or delete it, it's fine either way. But the ticket needs to reflect what actually took place.

Ann

---

G. Ann CAMPBELL | SonarSource

Product Owner

http://sonarsource.com

To view this discussion on the web visit https://groups.google.com/d/msgid/sonarqube/2d686ad7-4017-4c74-bc35-df0d9769bc62%40googlegroups.com.

[Izzet Mustafaiev]

Hi Ann,

Thanks for response.

On Wednesday, October 14, 2015 at 5:22:50 PM UTC+3, G. Ann Campbell wrote:

Hi Izzet,

I don't remember seeing the vote for this version. Could you point the thread out to me?

There is just this thread for the plugin, shall I create a thread to notify community?

Also, I'm confused by this ticket in the release: 

• #34 Remove misspelling metric

Rather than removing the metric, you appear to have populated it...? Somehow I can no longer add it as a components column, but it still shows up in the Measures interface:

Populate or delete it, it's fine either way. But the ticket needs to reflect what actually took place.

Sorry  for confusion, original intent was to remove, however after some work on the ticket we realised it makes more sense to populate it.

[G. Ann Campbell]

Yes, before each new release you should announce an RC and call a vote. Then I could have given you my feedback before the release. :-)

Also, could you update the ticket?

---

G. Ann CAMPBELL | SonarSource

Product Owner

http://sonarsource.com

To view this discussion on the web visit https://groups.google.com/d/msgid/sonarqube/2bd37846-32ee-4a1f-a3b0-d10f88fbfbf5%40googlegroups.com.

[Izzet Mustafaiev]

OK, thanks for clarification, will mark release in Github as not ready for production.

Ticket was updated.

Here is a link to thread regarding RC https://groups.google.com/forum/#!topic/sonarqube/a_QCXTcgPYQ. 

Thanks,

Izzet

[G. Ann Campbell]

Okay. Once you've closed the vote, ask me again.

---

G. Ann CAMPBELL | SonarSource

Product Owner

http://sonarsource.com

To view this discussion on the web visit https://groups.google.com/d/msgid/sonarqube/c101169f-844b-492f-9806-d854586de2e8%40googlegroups.com.