jmecosta / sonar-fsharp-plugin

F# SonarQube (TM) plugin - support for F#
GNU Lesser General Public License v3.0
52 stars 14 forks source link

The key of your plugin must be: not just the name of a language (e.g. cannot be java, rust, js/javascript, ...) #62

Closed milbrandt closed 5 years ago

milbrandt commented 5 years ago

beware also of rule 3e: "The key of your plugin must be: not just the name of a language (e.g. cannot be java, rust, js/javascript, ...)"

Originally posted by @otrosien in https://github.com/jmecsoftware/sonar-fsharp-plugin/issues/53#issuecomment-502960729

milbrandt commented 5 years ago

Thanks @otrosien I moved this to a separate issue as it has nothing do do with analyzing in sonarcloud. It is an important Point, even while there are other plugins on the market place which don't obey (eg Haskell). Contributors and supporters are always welcome ;)

@jmecosta Do have any preferences? Probably the key and the name should indicate the that this plugin is open source.

jmecosta commented 5 years ago

sonar-fsharp?

otrosien commented 5 years ago

I was thinking the same for my perl plugin (still waiting for confirmation that this is doable here: https://community.sonarsource.com/t/new-release-perl-plugin-0-4-0/5569/8?u=otrosien )

otrosien commented 5 years ago

dashes are not allowed btw.

milbrandt commented 5 years ago

Thanks Oliver, I'll watch your communication with Ann - but she mentioned in another thread to be out of office this week. The question regarding breaking all existing installations came also to my mind.

As your plugin is further down the road to marketplace we'll observe. For me sonarfsharp or communityfsharp would both be fine.

milbrandt commented 5 years ago

@jmecosta I would go for communityfsharp if it's ok for you as sonarXXX as in the above linked discussion there was a statement "although there’s nothing in the rules (yet!" - and I wouldn't like to make a breaking change of the key twice.