Class ClarityCheckTask

java.lang.Object
org.gradle.api.internal.AbstractTask
org.gradle.api.DefaultTask
ai.narrativetrace.gradle.ClarityCheckTask
All Implemented Interfaces:
Comparable<org.gradle.api.Task>, org.gradle.api.internal.DynamicObjectAware, org.gradle.api.internal.TaskInternal, org.gradle.api.Named, org.gradle.api.plugins.ExtensionAware, org.gradle.api.Task, org.gradle.util.Configurable<org.gradle.api.Task>

public abstract class ClarityCheckTask extends org.gradle.api.DefaultTask
Verification task that fails the build when clarity results violate configured thresholds.

INTENT: Use this task in CI to enforce naming quality from the JSON emitted by the clarity scanner or JUnit integrations.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface org.gradle.api.Task

    org.gradle.api.Task.Namer
  • Field Summary

    Fields inherited from interface org.gradle.api.Task

    TASK_ACTION, TASK_CONSTRUCTOR_ARGS, TASK_DEPENDS_ON, TASK_DESCRIPTION, TASK_GROUP, TASK_NAME, TASK_OVERWRITE, TASK_TYPE
  • Constructor Summary

    Constructors
    Constructor
    Description
     
  • Method Summary

    Modifier and Type
    Method
    Description
    void
    Executes the clarity check against the configured JSON result file.
    abstract org.gradle.api.file.RegularFileProperty
     
    abstract org.gradle.api.provider.Property<Integer>
     
    abstract org.gradle.api.provider.Property<Integer>
    Maximum suite-level issue count tolerated before the check fails.
    abstract org.gradle.api.provider.Property<Double>
     
    abstract org.gradle.api.file.RegularFileProperty
    Stamp file written on success to enable Gradle up-to-date checking.
    abstract org.gradle.api.provider.Property<Boolean>
     

    Methods inherited from class org.gradle.api.DefaultTask

    compareTo, configure, dependsOn, doFirst, doFirst, doFirst, doLast, doLast, doLast, finalizedBy, getActions, getAnt, getDependsOn, getDescription, getDestroyables, getDidWork, getEnabled, getExtensions, getFinalizedBy, getGroup, getInputs, getLocalState, getLogger, getLogging, getMustRunAfter, getName, getOutputs, getPath, getProject, getShouldRunAfter, getState, getTaskDependencies, getTemporaryDir, getTimeout, hasProperty, mustRunAfter, onlyIf, onlyIf, onlyIf, property, setActions, setDependsOn, setDescription, setDidWork, setEnabled, setFinalizedBy, setGroup, setMustRunAfter, setOnlyIf, setOnlyIf, setOnlyIf, setProperty, setShouldRunAfter, shouldRunAfter, usesService

    Methods inherited from class org.gradle.api.internal.AbstractTask

    acceptServiceReferences, appendParallelSafeAction, doNotTrackState, getAsDynamicObject, getConvention, getIdentityPath, getImpliesSubProjects, getLifecycleDependencies, getOnlyIf, getReasonNotToTrackState, getReasonTaskIsIncompatibleWithConfigurationCache, getRequiredServices, getServices, getSharedResources, getStandardOutputCapture, getTaskActions, getTaskIdentity, getTemporaryDirFactory, hasTaskActions, injectIntoNewInstance, isCompatibleWithConfigurationCache, isEnabled, isHasCustomActions, notCompatibleWithConfigurationCache, prependParallelSafeAction, setImpliesSubProjects

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface org.gradle.api.Task

    doNotTrackState, getConvention, notCompatibleWithConfigurationCache
  • Constructor Details

    • ClarityCheckTask

      public ClarityCheckTask()
  • Method Details

    • getJsonFile

      @Internal public abstract org.gradle.api.file.RegularFileProperty getJsonFile()
    • getStampFile

      @OutputFile public abstract org.gradle.api.file.RegularFileProperty getStampFile()
      Stamp file written on success to enable Gradle up-to-date checking.
    • getMinScore

      @Input public abstract org.gradle.api.provider.Property<Double> getMinScore()
    • getMaxHighIssues

      @Input public abstract org.gradle.api.provider.Property<Integer> getMaxHighIssues()
    • getMaxSuiteIssues

      @Input public abstract org.gradle.api.provider.Property<Integer> getMaxSuiteIssues()
      Maximum suite-level issue count tolerated before the check fails. Defaults to unlimited upstream, which keeps suite issues advisory (logged, never failing).
    • getWarnOnly

      @Input public abstract org.gradle.api.provider.Property<Boolean> getWarnOnly()
    • check

      public void check()
      Executes the clarity check against the configured JSON result file.