Re: [Codenarc-user] Checking out CodeNarc..

[Chris M. <chr...@ea...>]

Jeremy,

 

Thanks for the feedback.  I included the CodeNarc User List on this reply, since these issues  might interest other users.

 

I agree that one part of addressing these issues is to improve the rule descriptions and include suggested solutions. I expect we can make some progress on that.

As for the enhanced HTML report, I am open to enhancing the existing report – if it can be done without sacrificing portability (i.e. still be a single file with no external dependencies) and universal readability (everyone with a browser). Otherwise, we could look into perhaps providing another report type, or describe or provide an XSLT transformation for the existing XML report (see the mrhaki <http://mrhaki.blogspot.com/>  blog post about creating custom CodeNarc HTML reports using XSLT <http://mrhaki.blogspot.com/2011/01/groovy-goodness-create-codenarc-reports.html?utm_source=feedburner&utm_medium=feed&utm_campaign=Feed%3A+mrhaki+%28Messages+from+mrhaki%29> ) , though that would lose the existing HTML markup.

Please consider opening feature requests <https://sourceforge.net/tracker/?group_id=250145&atid=1126575>  for these issues.

The online documentation on the CodeNarc  web site <http://codenarc.sourceforge.net/index.html>  has more detailed information on the rules (at least for many of them). Specifically, for that rule, it includes: “Grails controller actions and interceptors are defined as properties on the controller class. Public methods on a controller class are unnecessary. They break encapsulation and can be confusing.”

But I know that you were bringing up the larger issue of the quality and immediacy of the descriptions and help info.

Thanks.

Chris

 

From: mes...@bo... [mailto:mes...@bo...] On Behalf Of Jeremy Flowers via LinkedIn
Sent: Saturday, January 22, 2011 11:22 AM
To: Chris Mair
Subject: Checking out CodeNarc..

 



LinkedIn


Jeremy Flowers has sent you a message.

Date: 1/22/2011 

Subject: Checking out CodeNarc.. 

When you have a rule that has been violated, instead of having a link to separate table, why not have a floating text box with the more detailed description when you hover over the link. I wasn't quite sure what GrailsPublicControllerMethod was supposed to be telling me either. The detailed message : Checks for public methods on Grails controller classes. Static methods are ignored. doesn't really advise what to do instead. It's a bit to cryptic. Any chance of giving descriptions that suggest solutions? 

 <http://www.linkedin.com/e/961093-gj8q8os7-4p/bHMlR5GR33zX2M_7sdy3N7NsJa8tU1l08-Xi/mbi/I1069419969_3/> View/reply to this message

Don't want to receive e-mail notifications?  <http://www.linkedin.com/e/961093-gj8q8os7-4p/bHMlR5GR33zX2M_7sdy3N7NsJa8tU1l08-Xi/blk/I1069419969_3/s6hJbOYWrSlI/mdp/> Adjust your message settings.

© 2010, LinkedIn Corporation