如何定义CodeNarc Gradle插件将扫描/分析的文件夹/目录

时间:2019-06-13 12:31:30

标签: gradle codenarc

我想做什么?

我想告诉CodeNarc应该扫描/分析哪些文件夹/目录。

我在官方网站(http://codenarc.sourceforge.net/)或gradle插件文档(https://docs.gradle.org/current/userguide/codenarc_plugin.html)上都找不到任何相关内容。

我的研究结果:

我发现的唯一相关内容是在grails CodeNarc插件文档(https://grails.org/plugin/codenarc)中。在那里,您可以配置CodeNarc分析哪些源文件。但这似乎仅适用于grails CodeNarc插件,而不适用于gradle版本。

gradle的CodeNarc文档描述了3个任务,其中一项具有以下内容:

codenarcSourceSet — CodeNarc

    Runs CodeNarc against the given source set’s Java source files

基于描述,我认为我可以做到这一点。 但是当我查找所有任务时,我的gradle项目只有“ codenarcMain”和“ codenarcTest”。

我的设置:

我的gradle项目具有以下结构:

.git
    -> ...
.gradle
    -> ...
config
    -> codenarc -> MyRuleset.groovy
gradle
    -> ...
src
    -> main
            -> groovy -> ...
            -> ressources
    -> test
            -> groovy -> ...
            -> ressources
vars
    -> ...
.gitignore
build.gradle
gradlew
gradlew.bat
ReadMe.txt
settings.gradle

我的build.gradle看起来像这样:

plugins {
    // Apply the groovy plugin to add support for Groovy
    id 'groovy'
    id 'codenarc'
}

repositories {
    // Use jcenter for resolving your dependencies.
    // You can declare any Maven/Ivy/file repository here.
    jcenter()
    maven { url "http://repo.jenkins-ci.org/releases/" }
    maven { url "http://central.maven.org/maven2/" }
}

dependencies {
    // https://mvnrepository.com/artifact/org.jenkins-ci.main/jenkins-core
    compile group: 'org.jenkins-ci.main', name: 'jenkins-core', version: '2.179'

    // https://mvnrepository.com/artifact/org.jenkins-ci.plugins/cloudbees-folder
    compile 'org.jenkins-ci.plugins:cloudbees-folder:5.3@jar'

    // https://mvnrepository.com/artifact/org.jenkins-ci.plugins.workflow/workflow-api
    compile 'org.jenkins-ci.plugins.workflow:workflow-api:2.35@jar'

    // https://mvnrepository.com/artifact/org.jenkins-ci.plugins.workflow/workflow-job
    compile 'org.jenkins-ci.plugins.workflow:workflow-job:2.32@jar'

    // https://mvnrepository.com/artifact/com.cloudbees/groovy-cps
    compile group: 'com.cloudbees', name: 'groovy-cps', version: '1.28'


    // https://mvnrepository.com/artifact/org.codenarc/CodeNarc
    codenarc group: 'org.codenarc', name: 'CodeNarc', version: '1.1'

    // Use the latest Groovy version for building this library
    implementation 'org.codehaus.groovy:groovy-all:2.5.6'

    // Use the awesome Spock testing and specification framework
    testImplementation 'org.spockframework:spock-core:1.2-groovy-2.5'
}

codenarc {
    configFile = file("${project.projectDir}/config/codenarc/MyRuleset.groovy")
    reportFormat = 'html'
    reportsDir = file("$buildDir/reports/StaticCodeAnalysis")
    maxPriority1Violations = 0
    maxPriority2Violations = 0
    maxPriority3Violations = 0
}

特定目标:

我基本上希望CodeNarc也扫描“ vars”文件夹/目录中的脚本。 但这似乎只在src / main / groovy和src / test / groovy内部执行。 我也不清楚确切的默认路径是什么,因为我没有在文档中找到它。

1 个答案:

答案 0 :(得分:0)

似乎您要做的就是将以下内容添加到gradle.build

sourceSets {
    main {
        groovy {
        srcDirs = ['src/main', 'vars']
        }
    }   
}

这样,CodeNarc扫描src / main文件夹内的所有内容以及vars文件夹内的所有内容。 (https://discuss.gradle.org/t/gradle-codenarc-plugin-how-to-change-target-folder-for-the-scan/32102/2