search

StevenLooman / magik-tools

Sonar Magik plugin
GNU General Public License v3.0
18 stars 10 forks source link

Add available options to their corresponding Wiki page #144

Closed sebastiaanspeck closed 5 days ago

sebastiaanspeck commented 1 week ago

Also moved the Bash code to a Python script

sebastiaanspeck commented 1 week ago

For the result: https://github.com/sebastiaanspeck/magik-tools/wiki and https://github.com/sebastiaanspeck/magik-tools/wiki/Checks-Options.

By adding this to the Wiki, IMO https://github.com/StevenLooman/magik-tools/pull/135 will be superfluous. Maybe we can add a link in the magik-lint-help to create some awareness for the Wiki?

StevenLooman commented 1 week ago

I think I was too brief in #135. Why do the parameters need to be in on a separate page? Lets add the parameters to the html files of the checks. This way the parameters end up on the wiki automatically.

Adding a separate page adds something which has to be kept in sync manually. Yes, the html has to be kept in sync as well, but it is a bit "closer" to the implementation of the check itself.

sebastiaanspeck commented 1 week ago

I think I was too brief in #135. Why do the parameters need to be in on a separate page? Lets add the parameters to the html files of the checks. This way the parameters end up on the wiki automatically.

Adding a separate page adds something which has to be kept in sync manually. Yes, the html has to be kept in sync as well, but it is a bit "closer" to the implementation of the check itself.

That makes things more clear, although adding the parameters to the html is maybe a bit redundant as in SonarQube they are also listed. I could also rewrite the Python file to extract the parameters from the Check.java and add them to their corresponding Wiki Check-page. That way we do not have to update the HTML ourselves since it is copied straight from the Check.java.

StevenLooman commented 1 week ago

Sounds like a less error prone way indeed. Please do so.

sebastiaanspeck commented 6 days ago

This somewhat depends on #140

sebastiaanspeck commented 6 days ago

Feel free to checkout my updated Wiki to see the result: https://github.com/sebastiaanspeck/magik-tools/wiki

StevenLooman commented 5 days ago

Looks good, thanks!