{"id":17045,"date":"2015-01-31T23:12:36","date_gmt":"2015-01-31T17:42:36","guid":{"rendered":"https:\/\/2thenew.today\/blog\/?p=17045"},"modified":"2015-07-24T16:58:42","modified_gmt":"2015-07-24T11:28:42","slug":"grails-clean-code-configure-codenarc-plugin","status":"publish","type":"post","link":"https:\/\/2thenew.today\/blog\/grails-clean-code-configure-codenarc-plugin\/","title":{"rendered":"Grails Clean Code – Configure Codenarc Plugin"},"content":{"rendered":"

Grails\u00a0gives us the freedom to create web applications quickly and with maximum productivity, but with the fast development, we often leave the basic code quality rules and after a few months of project we end up so much messy code that even we are not able to read it, forget about understanding it.<\/p>\n

Codenarc really helps to identify what is not expected from our code. We can setup the codenarc plugin<\/a> easily, but the default rulesets of plugins are sometimes not useful so download the default <\/a>rulesets and save the file in grails-app\/conf\/CodeNarcRules.groovy and then configure the plugin by adding following code in BuildConfig.groovy.<\/p>\n

[code]
\ncodenarc{
\n\truleSetFiles = "file:grails-app\/conf\/CodeNarcRules.groovy" \/\/ Ruleset file path
\n\treports = {
\n\t HtmlReport(‘html’) { \/\/ Report type is ‘html’
\n\t\toutputFile = ‘target\/CodeNarcReport.html’ \/\/Output file name
\n\t\ttitle = ‘My Test Code Narc Report’ \/\/ Title of the file
\n\t }
\n\t}
\n}
\n[\/code]<\/p>\n

After running the grails conarc command you will see some of the rules doesn’t fit to Grails infrastructure<\/a>, so we can just ignore them and update some rules in our CodeNarcRules.groovy file which can make our code quality bit better e.g; the following changes<\/p>\n

[code]
\nEmptyMethod{
\n doNotApplyToClassNames = "*Controller"
\n}
\nGrailsPublicControllerMethod{
\n\tenabled = false
\n}
\nMethodSize {
\n maxLines = 7
\n applyToClassNames = ‘*Controller’
\n}
\nMethodSize {
\n maxLines = 12
\n doNotApplyToClassNames = ‘*Controller’
\n}
\n[\/code]<\/p>\n

We can supress some warning on specific methods as well by just adding an annotation<\/p>\n

[code]
\n@SuppressWarnings([‘MethodSize’, ‘LineLength’])
\ndef someMethod(){
\n\/\/Code
\n}
\n[\/code]<\/p>\n

We can also integrate it with our build system so that if the code doesn’t pass the minimum criteria the build gets failed by updating your configurations in BuildConfig.groovy<\/p>\n

[code]
\ncodenarc{
\n\truleSetFiles = "file:grails-app\/conf\/CodeNarcRules.groovy"
\n maxPriority1Violations = 3
\n systemExitOnBuildException = true
\n\treports = {
\n\t HtmlReport(‘html’) { \/\/ Report type is ‘html’
\n\t\toutputFile = ‘target\/CodeNarcReport.html’
\n\t\ttitle = ‘My Test Code Narc Report’
\n\t }
\n\t}
\n}
\n[\/code]<\/p>\n

It always good to have tool which can show you your mistakes and guide you write more readable and maintainable code. Because of this plugin I was able to delete hunderds of lines of unused code in my project.<\/p>\n

Hope it helps<\/p>\n","protected":false},"excerpt":{"rendered":"

Grails\u00a0gives us the freedom to create web applications quickly and with maximum productivity, but with the fast development, we often leave the basic code quality rules and after a few months of project we end up so much messy code that even we are not able to read it, forget about understanding it. Codenarc really […]<\/p>\n","protected":false},"author":11,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"iawp_total_views":18,"footnotes":""},"categories":[7],"tags":[1614,1615,442,1589],"class_list":["post-17045","post","type-post","status-publish","format-standard","hentry","category-grails","tag-codenarc-plugin","tag-configure-codenarc-in-grails","tag-grails-performance","tag-grails-performance-optimization"],"aioseo_notices":[],"aioseo_head":"\n\t\t\n\t\n\t\n\t\n\t\n\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t\n\t\t