Vite for Gradle/opensavvy.gradle.vite.base.tasks/ViteExec

ViteExec

@CacheableTask

abstract class ViteExec @Inject constructor(process: ExecOperations) : DefaultTask(source)

Executes a Vite command in the context of this project.

For example, to run vite build:

tasks.register("viteBuild", ViteExec::class) {
    command.set("build")
    workingDirectory.set(project.layout.buildDirectory.dir("foo").asFile.toString())

    nodePath.set("…path to your Node installation…")
    vitePath.set("…path to your Vite installation…")
}

Constructors

@Inject

constructor(process: ExecOperations)

Properties

open var actions: List<Action<in Task>>

open val ant: AntBuilder

@get:Input

abstract val arguments: ListProperty<String>

Arguments passed to command.

asDynamicObject

@get:Internal

open val asDynamicObject: DynamicObject

@get:Input

@get:Optional

abstract val command: Property<String>

The Vite command to execute, for example run or build.

abstract val config: ViteConfig

The Vite configuration.

configurationFile

@get:InputFile

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val configurationFile: RegularFileProperty

The path to the vite.config.js file.

open val dependsOn: Set<Any>

open var description: @Nullable String?

open val destroyables: TaskDestroyables

open var didWork: Boolean

open var enabled: Boolean

open val extensions: ExtensionContainer

open val finalizedBy: TaskDependency

open var group: @Nullable String?

open val identityPath: Path

impliesSubProjects

open var impliesSubProjects: Boolean

open val inputs: TaskInputsInternal

isCompatibleWithConfigurationCache

open val isCompatibleWithConfigurationCache: Boolean

@get:Internal

open var isEnabled: Boolean

isHasCustomActions

open val isHasCustomActions: Boolean

lifecycleDependencies

@get:Internal

open val lifecycleDependencies: TaskDependencyInternal

open val localState: TaskLocalState

open val logger: Logger

open val logging: LoggingManager

open val mustRunAfter: TaskDependency

open val name: String

@get:Internal

abstract val nodePath: RegularFileProperty

The path to the Node executable.

open val onlyIf: Spec<in TaskInternal>

open val outputs: TaskOutputsInternal

open val path: String

open val project: Project

reasonNotToTrackState

open val reasonNotToTrackState: Optional<String>

reasonTaskIsIncompatibleWithConfigurationCache

open val reasonTaskIsIncompatibleWithConfigurationCache: Optional<String>

requiredServices

open val requiredServices: TaskRequiredServices

sharedResources

open val sharedResources: List<ResourceLock>

open val shouldRunAfter: TaskDependency

standardOutputCapture

open val standardOutputCapture: StandardOutputCapture

open val state: TaskStateInternal

open val taskActions: List<InputChangesAwareTaskAction>

taskDependencies

open val taskDependencies: TaskDependencyInternal

open val taskIdentity: TaskIdentity<*>

open val temporaryDir: File

temporaryDirFactory

open val temporaryDirFactory: Factory<File>

open val timeout: Property<Duration>

@get:InputFile

@get:PathSensitive(value = PathSensitivity.RELATIVE)

abstract val vitePath: RegularFileProperty

The path to the Vite executable.

workingDirectory

@get:Input

abstract val workingDirectory: Property<String>

The directory in which the command will be executed.

Functions

acceptServiceReferences

open fun acceptServiceReferences(serviceReferences: Set<ServiceReferenceSpec>)

appendParallelSafeAction

open fun appendParallelSafeAction(action: Action<in Task>)

open operator fun compareTo(otherTask: Task): Int

fun config(block: ViteConfig.() -> Unit): ViteConfig

open fun configure(closure: Closure<*>): Task

open fun dependsOn(vararg paths: Any): Task

open fun doFirst(action: Closure<*>): Task

open fun doFirst(action: Action<in Task>): Task

open fun doFirst(actionName: String, action: Action<in Task>): Task

open fun doLast(action: Closure<*>): Task

open fun doLast(action: Action<in Task>): Task

open fun doLast(actionName: String, action: Action<in Task>): Task

doNotTrackState

open fun doNotTrackState(reasonNotToTrackState: String)

open fun finalizedBy(vararg paths: Any): Task

open fun hasProperty(propertyName: String): Boolean

open fun hasTaskActions(): Boolean

open fun mustRunAfter(vararg paths: Any): Task

notCompatibleWithConfigurationCache

open fun notCompatibleWithConfigurationCache(reason: String)

open fun onlyIf(onlyIfClosure: Closure<*>)

open fun onlyIf(spec: Spec<in Task>)

open fun onlyIf(onlyIfReason: String, spec: Spec<in Task>)

prependParallelSafeAction

open fun prependParallelSafeAction(action: Action<in Task>)

open fun property(propertyName: String): Any

open fun setDependsOn(dependsOn: Iterable<*>)

open fun setFinalizedBy(finalizedByTasks: Iterable<*>)

setMustRunAfter

open fun setMustRunAfter(mustRunAfterTasks: Iterable<*>)

open fun setOnlyIf(onlyIfClosure: Closure<*>)

open fun setOnlyIf(spec: Spec<in Task>)

open fun setOnlyIf(onlyIfReason: String, spec: Spec<in Task>)

open fun setProperty(name: String, value: Any)

setShouldRunAfter

open fun setShouldRunAfter(shouldRunAfterTasks: Iterable<*>)

open fun shouldRunAfter(vararg paths: Any): TaskDependency

open fun usesService(service: Provider<out BuildService<*>>)