Hi all, yesterday we merged checkstyle integration in Hibernate OGM: it's going to fail the compile phase if there are violations (!). By doing so, we also had to re-style a large portion of code, as surprisingly even though I though we where very careful on style and whitespace inspections, human eye is still far behind the power of such a tool. Sorry for the conflicts this caused: we hope it's a smaller price to pay compared to the long term benefits. I realize this might look very inconvenient initially to have it fail during some quick experimental hacking, but the purpose is to encourage applying the correct autoformatting styles in your IDE: it should not annoy you once you get use to obey the rules. The purpose is to reduce the back-and-forth discussions for which pull requests have been delayed for style reasons, not using tabs for indent, missing/wrong copyright headers... also it should reduce conflicts in the future. This definitely will look annoying initially, but please try surviging the initial push back and fix your style. If it still is annoying in the long run we can discuss relaxing the rules or demoting it from a compile failure to some warning levels. If things don't look too bad (i.e. I don't get enough complaints) I will soon send a pull request for Search too, and I hope other projects will follow. Cheers, Sanne _______________________________________________ hibernate-dev mailing list hibernate-dev(a)lists.jboss.org https://lists.jboss.org/mailman/listinfo/hibernate-dev

Hi all, yesterday we merged checkstyle integration in Hibernate OGM: it's going to fail the compile phase if there are violations (!).

Yeah, I was just about to suggest that :)

2013/4/18 Hardy Ferentschik <hardy(a)hibernate.org&gt; > > > On 18 Jan 2013, at 4:48 PM, Sanne Grinovero <sanne(a)hibernate.org&gt; wrote: > > > Hi all, > > > > yesterday we merged checkstyle integration in Hibernate OGM: it's > > going to fail the compile phase if there are violations (!). > > +1 Joining the ranks of Validator and Search :-)

> > Btw, in HV Gunnar convinced me to attache the checkstyle plugin to the > verify phase. > This way you can hack away w/o caring too much about a coding style since > the compile > will work. However, a full 'mvn install' will fail. > > --Hardy > > > _______________________________________________ > hibernate-dev mailing list > hibernate-dev(a)lists.jboss.org > https://lists.jboss.org/mailman/listinfo/hibernate-dev

On 18 Jan 2013, at 5:27 PM, Sanne Grinovero <sanne(a)hibernate.org&gt; wrote: > On 18 April 2013 16:13, Gunnar Morling <gunnar(a)hibernate.org&gt; wrote: >> Yeah, I was just about to suggest that :) > > Good idea, but isn't it true that if your IDE is correctly setup it doesn't matter? True, but sometimes you might want to ignore the rules. > I'm not sure about IDEA, but Eclipse detects the checkstyle rules and > shows violations right away. Not sure, I don't have any check style plugin enabled in Idea. And again, it is a question of IDE vs build. Wether and how you configure your IDE to conform to the coding standard is one thing and where and how you check the standard as part of the build is another. --Hardy

Also you're not always in your IDE. For instance I recently tried to change something experimentally in the AS code base, just using my text editor (no, it was not vi ;). Then CS can really be in the way for compilation/tests. So I think it makes most sense to have it in the "verify" phase. 2013/4/18 Hardy Ferentschik <hardy(a)hibernate.org&gt; > > On 18 Jan 2013, at 5:27 PM, Sanne Grinovero <sanne(a)hibernate.org&gt; wrote: > > > On 18 April 2013 16:13, Gunnar Morling <gunnar(a)hibernate.org&gt; wrote: > >> Yeah, I was just about to suggest that :) > > > > Good idea, but isn't it true that if your IDE is correctly setup it > doesn't matter? > > True, but sometimes you might want to ignore the rules. > > > I'm not sure about IDEA, but Eclipse detects the checkstyle rules and > > shows violations right away. > > Not sure, I don't have any check style plugin enabled in Idea. And again, > it > is a question of IDE vs build. Wether and how you configure your IDE to > conform to the coding standard is one thing and where and how you check > the standard as part of the build is another. > > --Hardy > > _______________________________________________ hibernate-dev mailing list hibernate-dev(a)lists.jboss.org https://lists.jboss.org/mailman/listinfo/hibernate-dev

On 18 April 2013 17:12, Davide D'Alto <daltodavide(a)gmail.com&gt; wrote: > I don't have any particular objection to set it on the verify phase. I tend > to always use mvn install anyway. > > The argument I can use to promote the compile phase (for sake of discussion > only) > I like the fact that I can check the code writing mvn compile, therefore > without starting any test. > If you think you are going to prototype something big you can always you > can always change the attribute failsOnError to false. right but if this motivates people to hardcode -DfailsOnError-false in their scripts, we're back to square one ;-)

IDEA has a checkstyle plugin (and a jdepend plugin fwiw). And it will also immediately show violations in the editor (as well as collect them in the problems window). It does not auto detect the settings however, you need to point it to the file. You can still compile, run tests, etc. Very ideal imo. On 04/18/2013 10:27 AM, Sanne Grinovero wrote: > On 18 April 2013 16:13, Gunnar Morling <gunnar(a)hibernate.org&gt; wrote: >> Yeah, I was just about to suggest that :) > Good idea, but isn't it true that if your IDE is correctly setup it > doesn't matter? > I'm not sure about IDEA, but Eclipse detects the checkstyle rules and > shows violations right away. > > >> 2013/4/18 Hardy Ferentschik <hardy(a)hibernate.org&gt; >>> >>> On 18 Jan 2013, at 4:48 PM, Sanne Grinovero <sanne(a)hibernate.org&gt; wrote: >>> >>>> Hi all, >>>> >>>> yesterday we merged checkstyle integration in Hibernate OGM: it's >>>> going to fail the compile phase if there are violations (!). >>> +1 Joining the ranks of Validator and Search :-) > To clarify, the set of rules defined in OGM are significantly stricter > than what we had in Search initially. > > Cheers, > Sanne > >>> Btw, in HV Gunnar convinced me to attache the checkstyle plugin to the >>> verify phase. >>> This way you can hack away w/o caring too much about a coding style since >>> the compile >>> will work. However, a full 'mvn install' will fail. >>> >>> --Hardy >>> >>> >>> _______________________________________________ >>> hibernate-dev mailing list >>> hibernate-dev(a)lists.jboss.org >>> https://lists.jboss.org/mailman/listinfo/hibernate-dev >> > _______________________________________________ > hibernate-dev mailing list > hibernate-dev(a)lists.jboss.org > https://lists.jboss.org/mailman/listinfo/hibernate-dev _______________________________________________ hibernate-dev mailing list hibernate-dev(a)lists.jboss.org https://lists.jboss.org/mailman/listinfo/hibernate-dev

Where can I find the new style rule for Intellij and the checktyle plugin ?

btw, what do you guys think of sonar? shall we give it a try on ci.hibernate.org? On Apr 19, 2013, at 4:32 PM, Hardy Ferentschik <hardy(a)hibernate.org&gt; wrote: > > On 19 Jan 2013, at 9:54 AM, Guillaume SCHEIBEL <guillaume.scheibel(a)gmail.com&gt; wrote: > >> Where can I find the new style rule for Intellij and the checktyle plugin ? > > I think the existing style rules have not changed. See also https://community.jboss.org/wiki/ContributingtoHibernateSearch#Idea > It is just that we enforce the rules now as part of the build. > > --Hardy > ------------------------- Best Regards, Strong Liu <stliu at hibernate.org> http://about.me/stliu/bio

+1 next on my wishlist, and was already chatting about it with Steve the other days. You guys should not hide from IRC :-P I won't be able to do it now, but feel free to add the repository, package name and necessary configuration changes in the ci.hibernate.org repository so that it gets auto-installed as well at the next machine refresh. Or I'll look into it when I can. What URL would you all expect it on? Apparently if we want a different subdomain that takes quite some time; I'd expect something like - ci.hibernate.org/sonar ? - sonar.hibernate.org ? - hibernate.org/sonar ? I'd pick the first one as I perceive it as a secondary service, we can then add a prominent link on the header of ci.hibernate.org to point to it: we'd likely want to edit the header anyway to link to hibernate.org, github et al.

Sanne On 19 April 2013 10:29, Hardy Ferentschik <hardy(a)hibernate.org&gt; wrote: > Sonar is great. I am running it locally to get the metrics. That's the part I am missing for HV on Cloudbees. Unfortunately, it is not included in the free offering. > > > > --hardy > > > > On 19 Apr 2013, at 11:24, Strong Liu <stliu(a)hibernate.org&gt; wrote: > >> btw, what do you guys think of sonar? >> >> shall we give it a try on ci.hibernate.org? >> >> >> On Apr 19, 2013, at 4:32 PM, Hardy Ferentschik <hardy(a)hibernate.org&gt; wrote: >> >>> >>> On 19 Jan 2013, at 9:54 AM, Guillaume SCHEIBEL < guillaume.scheibel(a)gmail.com&gt; wrote: >>> >>>> Where can I find the new style rule for Intellij and the checktyle plugin ? >>> >>> I think the existing style rules have not changed. See also https://community.jboss.org/wiki/ContributingtoHibernateSearch#Idea >>> It is just that we enforce the rules now as part of the build. >>> >>> --Hardy >>> >> >> ------------------------- >> Best Regards, >> >> Strong Liu <stliu at hibernate.org> >> http://about.me/stliu/bio >> >> >> > _______________________________________________ > hibernate-dev mailing list > hibernate-dev(a)lists.jboss.org > https://lists.jboss.org/mailman/listinfo/hibernate-dev _______________________________________________ hibernate-dev mailing list hibernate-dev(a)lists.jboss.org https://lists.jboss.org/mailman/listinfo/hibernate-dev

So far so good, for the maven build I have added 2 things: - <excludes>**/target/generated-sources/*.java</excludes> into the hibernate-ogm-parent checkstyle plugin conf, to avoid the check of the generated classes - <property name="lineSeparator" value="lf"/> to the checkstyle config (module NewlineAtEndOfFile) otherwise, each file had an issue about newline missing. WDYT ? 2013/4/19 Gunnar Morling <gunnar(a)hibernate.org&gt; > 2013/4/19 Sanne Grinovero <sanne(a)hibernate.org&gt; > > > +1 > > next on my wishlist, and was already chatting about it with Steve the > > other days. You guys should not hide from IRC :-P > > I won't be able to do it now, but feel free to add the repository, > > package name and necessary configuration changes in the > > ci.hibernate.org repository so that it gets auto-installed as well at > > the next machine refresh. Or I'll look into it when I can. > > > > What URL would you all expect it on? Apparently if we want a different > > subdomain that takes quite some time; I'd expect something like > > > > - ci.hibernate.org/sonar ? > > - sonar.hibernate.org ? > > - hibernate.org/sonar ? > > > > I'd pick the first one as I perceive it as a secondary service, we can > > then add a prominent link on the header of ci.hibernate.org to point > > to it: we'd likely want to edit the header anyway to link to > > hibernate.org, github et al. > > > > I guess I'd like sonar.hibernate.org most since I'd consider the two > services to be on the same level. But the others surely work, too. > > One issue I had in the past with Sonar was that its configuration > (FindBugs, CheckStyle etc.) was independent from the corresponding > configuration for the build (Maven plug-ins). I.e. you had to change config > at two places when e.g. adding a new rule. > > Therefore I preferred to use the Jenkins plug-ins for FindBugs, CheckStyle > etc, which then could use the same configuration as the Maven plug-ins. > Maybe that's not an issue anymore, though. > > FWIW, I also liked having this info in Jenkins directly instead of having > yet another tool. But if you all love Sonar, that's fine with me, too. > > --Gunnar > > > > > > > Sanne > > > > > > > > On 19 April 2013 10:29, Hardy Ferentschik <hardy(a)hibernate.org&gt; wrote: > > > Sonar is great. I am running it locally to get the metrics. That's the > > part I am missing for HV on Cloudbees. Unfortunately, it is not included > in > > the free offering. > > > > > > > > > > > > --hardy > > > > > > > > > > > > On 19 Apr 2013, at 11:24, Strong Liu <stliu(a)hibernate.org&gt; wrote: > > > > > >> btw, what do you guys think of sonar? > > >> > > >> shall we give it a try on ci.hibernate.org? > > >> > > >> > > >> On Apr 19, 2013, at 4:32 PM, Hardy Ferentschik <hardy(a)hibernate.org > > > wrote: > > >> > > >>> > > >>> On 19 Jan 2013, at 9:54 AM, Guillaume SCHEIBEL < > > guillaume.scheibel(a)gmail.com&gt; wrote: > > >>> > > >>>> Where can I find the new style rule for Intellij and the checktyle > > plugin ? > > >>> > > >>> I think the existing style rules have not changed. See also > > https://community.jboss.org/wiki/ContributingtoHibernateSearch#Idea > > >>> It is just that we enforce the rules now as part of the build. > > >>> > > >>> --Hardy > > >>> > > >> > > >> ------------------------- > > >> Best Regards, > > >> > > >> Strong Liu <stliu at hibernate.org> > > >> http://about.me/stliu/bio > > >> > > >> > > >> > > > _______________________________________________ > > > hibernate-dev mailing list > > > hibernate-dev(a)lists.jboss.org > > > https://lists.jboss.org/mailman/listinfo/hibernate-dev > > _______________________________________________ > > hibernate-dev mailing list > > hibernate-dev(a)lists.jboss.org > > https://lists.jboss.org/mailman/listinfo/hibernate-dev > > > _______________________________________________ > hibernate-dev mailing list > hibernate-dev(a)lists.jboss.org > https://lists.jboss.org/mailman/listinfo/hibernate-dev > _______________________________________________ hibernate-dev mailing list hibernate-dev(a)lists.jboss.org https://lists.jboss.org/mailman/listinfo/hibernate-dev