Task classes

Task

Task name for main sourceset

Description

PnpmAllowBuildsTask

jseTrustSupplyChainPackages

Equivalent of pnpm approve-builds.

PnpmBuildTask

jseAssemble

Validates and transpiles as needed.

PnpmRecursiveBuildTask

jseAssemble

Validates and transpiles as needed within a workspace/ Equivalent of running pnpm -r run build/

PnpmCacheBinariesTask

jsePnpmCacheBinaries

Explicitly caches pnpm and node binaries.

PnpmCiTask

jseCiInstallPackages

The equivalent of running pnpm ci.

PnpmExecTask

-

The equivalent of running pnpm exec. Primarily used for custom tasks.

PnpmInstallDryRunTask

jseInstallPackagesDryRun

The equivalent of running pnpm install --dry-run.

PnpmInstallTask

jseInstallPackages

The equivalent of running pnpm install.

PnpmPrepareTask

-

Normally associated with a PnpmExecTask and used to individually install packages.

PnpmRunScriptTask

Typically jseRun<ScriptName>, but could have other names if explicitly registered.

Used to run scripts in package.json. Can be dynamically invoked via a rule or explicit tasks can be registered.

PnpmRecursiveRunTask

Typically jseRun<TaskName>, but could have other names if explicitly registered.

Used to run tasks in pnpm-workspace-yaml. Can be dynamically invoked via a rule or explicit tasks can be registered. Equivalent of pnpm -r run <Task>.

PnpmRecursiveTestTask

jseTest

Equivalent of pnpm -r run test.

PnpmTestTask

jseTest

Equivalent of pnpm test.

PnpmWrapperTask

jsePnpmWrapper

Creates wrapper scripts for pnpm.

PnpmWorkspacePackageRunTask

Typically jseWsRun<PackageName><ScriptName>, but could have other names if explicitly registered.

Used to run scripts within packages of a workspace. in pnpm-workspace-yaml. Onlay available if the lifecycle is configured to support scanning of the workspace. Equivalent of pnpm -r run --filter <PackageName> <ScriptName>.

PnxTask

-

Allows registration of tasks that will use pnx under the hood.

Task

Description

AbstractPnpmInstallBaseTask

For implementation of tasks that install packages. Not normally used by build script authors.

AbstractPnpmLifecycleTask

Useful to implement a pnpm command. Need to be configured with a toolchain, a working directory and an optional environment.

AbstractPnpmRunTask

Useful to implement specific pnpm run tasks.

AbstractPnpmRecursiveRunTask

Useful to implement specific pnpm -r run tasks. Extends from AbstractPnpmLifecycleTask.

AbstractPnpmTask

Used to deal with more complex scenarios in the pnpm world for when AbstractPnpmLifecycleTask is not suitable.