Skip to content
This repository has been archived by the owner on Jan 30, 2023. It is now read-only.

Refactor the Scalastyle Plugin #35

Closed
5 tasks done
BalmungSan opened this issue Mar 23, 2018 · 5 comments
Closed
5 tasks done

Refactor the Scalastyle Plugin #35

BalmungSan opened this issue Mar 23, 2018 · 5 comments

Comments

@BalmungSan
Copy link
Contributor

BalmungSan commented Mar 23, 2018

@BalmungSan
Copy link
Contributor Author

Well, the time to tackle this has come.

IMHO, I see no value in only refactoring the rules repository, and I think we should refactor the entire module at once. Of course doing a big one PR to change all it's not a good idea (we learned that from the Scoverage refactor), so we probably will do something similar of what we did for Scapegoat, tackling this part by part, without removing the old module until the new one is ready.

I haven't given a detailed review to this, but this is a high level task list:

  • SBT code generation task, to create a file with all the Scalastyle rules.
  • Scalastyle rules repository.
  • Scalastyle quality profile.
  • Scalastyle sensor (Includes feature flag).
  • Docs, examples & release.

What do you think @mwz ?

@mwz
Copy link
Member

mwz commented Jul 8, 2018

It looks like a good list to me!

@BalmungSan
Copy link
Contributor Author

Great!

Now, I think I will be busy for a few days, so if you want and can start with the SBT task, that would be great.

I think we should do something similar of what we did for scapegoat, using fast-classpath-scanner to get all classes that inherit from Checker (Or maybe from Scalariform Checker).

But no idea of what we can extract from they.

@mwz
Copy link
Member

mwz commented Jul 9, 2018

I think we should do something similar of what we did for scapegoat, using fast-classpath-scanner to get all classes that inherit from Checker (Or maybe from Scalariform Checker).

I don't think that we'll need to use the fast-classpath-scanner for Scalastyle, because everything we need is actually located in the xml config files in the resources here.

@BalmungSan
Copy link
Contributor Author

"I don't think that we'll need to use the fast-classpath-scanner for Scalastyle, because everything we need is actually located in the xml config files in the resources here."

Oh that's cool 🎉

@mwz mwz self-assigned this Aug 18, 2018
@mwz mwz moved this from To do to In progress in sonar-scala Aug 18, 2018
@mwz mwz mentioned this issue Sep 18, 2018
@mwz mwz closed this as completed Sep 30, 2018
sonar-scala automation moved this from In progress to Done Sep 30, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
sonar-scala
  
Done
Development

No branches or pull requests

2 participants