sirthias / parboiled

Elegant parsing in Java and Scala - lightweight, easy-to-use, powerful.
http://parboiled.org
Apache License 2.0
1.28k stars 156 forks source link

Maven Site Reporting #72

Closed msknapp closed 10 years ago

msknapp commented 10 years ago

The project could learn a lot about what needs to be improved, what are potential bugs, and what needs to be tested, if you add a couple maven plugins to the pom.

Maven plugins for PMD, CPD, cobertura, findbugs, checkstyle, and javadocs would be really useful. The goal is to have "mvn site" generate your project's website with several reports on code quality.

I would just do this myself, but I am not familiar with scala and your build process. The project doesn't seem to have any pom files, but after running your build process it does somehow, which confuses me.

For an example of what I want, look at the reporting section of this pom file that I edited a few days ago:

https://github.com/SQiShER/java-object-diff/blob/master/pom.xml

alternatively, if you tell me how to update pom files for this project I will do it myself and submit a patch/pull request.

sirthias commented 10 years ago

Thanks for the suggestion, Michael, but I don't particularly like Maven as a build-tool. I'd like to stick with SBT for the project. Also, there is now parboiled2, which will receive the much larger share of my attention in the future....

msknapp commented 10 years ago

What's really important to me is not switching to maven, it's getting these metrics. Isn't there any way to have SBT run cobertura, PMD, CPD, etc. for these projects?

antonkulaga commented 10 years ago

Findbugs have sbt binding ( https://bitbucket.org/jmhofer/findbugs4sbt/wiki/Home ), docs can be generated by sbt http://www.scala-sbt.org/release/docs/Howto/scaladoc.html , for stylechecking it is possible to use scalastyle ( http://www.scalastyle.org/sbt.html ). And I also suggest to port your code to parboloied2 as it uses macroses compiletime code generation and thus is much faster.

sirthias commented 10 years ago

Isn't there any way to have SBT run cobertura, PMD, CPD, etc. for these projects?

There might be. If you would like to submit a pull request, I'd be happy to look at it.