org.ysb33r.gradle.jse.pnpm.toolchains

Interface JsePnpmToolchain

All Superinterfaces:

org.ysb33r.grolifant5.api.core.runnable.BaseToolLocation, org.ysb33r.gradle.jsecosystem.toolchains.JseBootstrappableToolchain, org.ysb33r.gradle.jsecosystem.toolchains.JseBootstrappableToolchainWithCommandExecSpec<JsePnpmExecSpec>, org.ysb33r.gradle.jsecosystem.toolchains.JseToolchain, org.ysb33r.gradle.jsecosystem.toolchains.JseToolchainWithCommandExecSpec<JsePnpmExecSpec>, org.gradle.api.Named, org.ysb33r.grolifant5.api.core.runnable.ToolLocation

public interface JsePnpmToolchain
extends org.ysb33r.gradle.jsecosystem.toolchains.JseBootstrappableToolchainWithCommandExecSpec<JsePnpmExecSpec>

Brings PNPM into the Gradle JavaScript ecosystem.

Since:

5.0

Nested Class Summary

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

org.gradle.api.Named.Namer

Method Summary

Modifier and Type	Method and Description
org.gradle.api.provider.Provider<java.io.File>	getNodeBinDir() Directory where node is located.
org.gradle.api.provider.Provider<java.io.File>	getStoreDir() Get the location of the store directory.
org.gradle.api.provider.Provider<org.ysb33r.gradle.jse.pnpm.toolchains.JsePnpmStoreLayout>	getStoreLayout() A provider to the store layout.
void	setStoreDir(java.lang.Object storeDir) Override the store directory.
void	withNodeToolchain(org.gradle.api.provider.Provider<? extends org.ysb33r.gradle.jse.node.toolchains.JseNodeToolchain> tc) Associate this toolchain with a specific node toolchain.
void	withNodeToolchain(java.lang.String tcName) Associate this toolchain with a specific node toolchain.
void	withPnpmNode() Have pnpm manage its own node installation.
void	withPnpmNode(java.lang.Object ver) Have pnpm manage its own node installation.

Methods inherited from interface org.ysb33r.grolifant5.api.core.runnable.ToolLocation

executableByVersion

Methods inherited from interface org.ysb33r.gradle.jsecosystem.toolchains.JseToolchainWithCommandExecSpec

createExecSpec, createExecSpec

Methods inherited from interface org.ysb33r.gradle.jsecosystem.toolchains.JseToolchain

getExecutableVersion

Methods inherited from interface org.ysb33r.grolifant5.api.core.runnable.BaseToolLocation

executableByPath, executableBySearchPath, getExecutable, getWindowsExtensionSearchOrder, setWindowsExtensionSearchOrder, setWindowsExtensionSearchOrder

Methods inherited from interface org.gradle.api.Named

getName

Method Detail

withNodeToolchain

void withNodeToolchain(java.lang.String tcName)

Associate this toolchain with a specific node toolchain.

Parameters:

tcName - Name of toolchain.

withNodeToolchain

void withNodeToolchain(org.gradle.api.provider.Provider<? extends org.ysb33r.gradle.jse.node.toolchains.JseNodeToolchain> tc)

Associate this toolchain with a specific node toolchain.

Parameters:

tc - Provider of toolchain.

withPnpmNode

void withPnpmNode()

Have pnpm manage its own node installation.

The version of node is a default determined by the plugin.

withPnpmNode

void withPnpmNode(java.lang.Object ver)

Have pnpm manage its own node installation.

Parameters:

ver - Version string. Must be in semantic version format.

getNodeBinDir

org.gradle.api.provider.Provider<java.io.File> getNodeBinDir()

Directory where node is located.

This value will be finalized on the first read.

Returns:

Provider to the node bin directory.

setStoreDir

void setStoreDir(java.lang.Object storeDir)

Override the store directory.

By default, this is ~/.gradle/caches/pnpm. On Windows, if the build runs on a different drive than the user's home Gradle directory, a directory .gradle/caches/pnpm will be created on that drive.

Parameters:

storeDir - New location of store directory.

getStoreDir

org.gradle.api.provider.Provider<java.io.File> getStoreDir()

Get the location of the store directory.

Returns:

Location of store. Never null.

getStoreLayout

org.gradle.api.provider.Provider<org.ysb33r.gradle.jse.pnpm.toolchains.JsePnpmStoreLayout> getStoreLayout()

A provider to the store layout.

Returns:

Provider. Niver null or empty.