How to exclude a package from codenarc?

Question

I am new to Gradle and Codenarc but I found no example showing how to exclude a package from codenarc reports.

For example, I have a groovy application that uses, for instance, the package myapp.main and myapp.legacy

I want all my ruleset applied to myapp.main but none to myapp.legacy. How can I accomplish that?

score 1 · Accepted Answer · answered Sep 22 '13 at 14:07

There are a couple of places where to look for such information:

The Gradle User Guide, which has a chapter for each plugin.
The Gradle Build Language Reference (specifically the CodeNarc task type).
The samples in the full Gradle distribution.
The Gradle forums.

According to 2., an include or exclude filter should do the trick. For example:

codenarcMain {
    exclude "myapp/legacy/**"
}

Ali Asgari · Answer 2 · 2023-05-19T17:16:31.623

The other answer seems to be a little bit old. For codenarc documentation itself it is best to refer to its website.

As explained there you can include or exclude files, packages or classes from rules by specifying every rules' properties in the config file. An example is bellow:

CatchThrowable.doNotApplyToClassNames=BaseController,AbstractTest

FieldName.applyToClassNames=org.codenarc.CodeNarc,org.codenarc.extra.*

How to exclude a package from codenarc?

2 Answers2