Package com.integrallis.mfcqi.gradle

Class MfcqiExtension

java.lang.Object
com.integrallis.mfcqi.gradle.MfcqiExtension
public abstract class MfcqiExtension extends Object
Configuration for the MFCQI Gradle plugin. 
 mfcqi {
     source = layout.projectDirectory        // what to analyze (default: project dir)
     parallelism = 4                          // metric workers (default: CPU count)
     jsonReport = layout.buildDirectory.file("reports/mfcqi/mfcqi.json")
     badgeFile = layout.projectDirectory.file(".github/badges/mfcqi.json")
     failOnGate = true                        // fail the build when a quality gate fails
 }

  • Constructor Summary

    Constructors
    Constructor
    Description
    MfcqiExtension()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    abstract org.gradle.api.file.RegularFileProperty
    getBadgeFile()
    Badge JSON destination.
    abstract org.gradle.api.provider.Property<Boolean>
    getBytecodeSecurity()
    Use real SpotBugs+FindSecBugs bytecode SAST for the security metric (both Java and Kotlin) when compiled classes are available.
    abstract org.gradle.api.provider.Property<Boolean>
    getFailOnGate()
    Whether mfcqiGate fails the build on a gate failure.
    abstract org.gradle.api.file.RegularFileProperty
    getGateFile()
    Optional explicit quality-gate config; otherwise .mfcqi.yaml is auto-discovered.
    abstract org.gradle.api.file.RegularFileProperty
    getJsonReport()
    Optional JSON report destination.
    abstract org.gradle.api.provider.Property<Integer>
    getParallelism()
    Number of metric workers.
    abstract org.gradle.api.file.DirectoryProperty
    getSource()
    Source root to analyze.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Constructor Details

    • MfcqiExtension

      public MfcqiExtension()

  • Method Details

    • getSource

      public abstract org.gradle.api.file.DirectoryProperty getSource()
      Source root to analyze. Defaults to the project directory.

    • getParallelism

      public abstract org.gradle.api.provider.Property<Integer> getParallelism()
      Number of metric workers. Defaults to the available processor count.

    • getJsonReport

      public abstract org.gradle.api.file.RegularFileProperty getJsonReport()
      Optional JSON report destination.

    • getBadgeFile

      public abstract org.gradle.api.file.RegularFileProperty getBadgeFile()
      Badge JSON destination. Defaults to .github/badges/mfcqi.json.

    • getGateFile

      public abstract org.gradle.api.file.RegularFileProperty getGateFile()
      Optional explicit quality-gate config; otherwise .mfcqi.yaml is auto-discovered.

    • getFailOnGate

      public abstract org.gradle.api.provider.Property<Boolean> getFailOnGate()
      Whether mfcqiGate fails the build on a gate failure. Defaults to true.

    • getBytecodeSecurity

      public abstract org.gradle.api.provider.Property<Boolean> getBytecodeSecurity()
      Use real SpotBugs+FindSecBugs bytecode SAST for the security metric (both Java and Kotlin) when compiled classes are available. Defaults to true; falls back to source heuristics.