Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor the Scalastyle Plugin #35

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

Refactor the Scalastyle Plugin #35

BalmungSan opened this issue Mar 23, 2018 · 5 comments
Assignees
Projects

Comments

@BalmungSan
Copy link
Contributor

@BalmungSan BalmungSan commented Mar 23, 2018

  • SBT code generation task, to create a file with all the Scalastyle rules. (@mwz, #101)
  • Scalastyle rules repository. (@mwz, #105)
  • Scalastyle quality profile. (@mwz, #108)
  • Scalastyle sensor (Includes feature flag). (@mwz, #114)
  • Docs, examples & release.
This was referenced Mar 23, 2018
@mwz mwz added this to To do in sonar-scala Jul 8, 2018
@BalmungSan

This comment has been minimized.

Copy link
Contributor Author

@BalmungSan BalmungSan commented Jul 8, 2018

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

This comment has been minimized.

Copy link
Owner

@mwz mwz commented Jul 8, 2018

It looks like a good list to me!

@BalmungSan

This comment has been minimized.

Copy link
Contributor Author

@BalmungSan BalmungSan commented Jul 8, 2018

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

This comment has been minimized.

Copy link
Owner

@mwz 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

This comment has been minimized.

Copy link
Contributor Author

@BalmungSan BalmungSan commented Jul 10, 2018

"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 Sep 30, 2018
sonar-scala automation moved this from In progress to Done Sep 30, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
sonar-scala
  
Done
2 participants
You can’t perform that action at this time.