@ui5/builder/tasks/runTask
Runs a UI5 Builder task without a build cache.
A task default-exports a factory defineTask(options) => descriptor. A traditional descriptor's task function runs directly. For a descriptor with a steps array, this runner is the no-cache counterpart to the cached step runner in @ui5/project (which @ui5/builder cannot import, the dependency direction being @ui5/cli -> @ui5/project -> @ui5/builder): it runs every step in order, fans out every map step's keys set, threads needs returns in memory, and buffers a concurrent map step's writes so they flush in key order. It replaces the per-task batch fallback tasks used to hand-write for standalone (direct or programmatic) invocation of @ui5/builder.
Delta selection, CAS-backed returns, tag replay and signature computation are cache concerns and are absent here; every step runs.
Description: Runs a UI5 Builder task without a build cache.
A task default-exports a factory defineTask(options) => descriptor. A traditional descriptor's task function runs directly. For a descriptor with a steps array, this runner is the no-cache counterpart to the cached step runner in @ui5/project (which @ui5/builder cannot import, the dependency direction being @ui5/cli -> @ui5/project -> @ui5/builder): it runs every step in order, fans out every map step's keys set, threads needs returns in memory, and buffers a concurrent map step's writes so they flush in key order. It replaces the per-task batch fallback tasks used to hand-write for standalone (direct or programmatic) invocation of @ui5/builder.
Delta selection, CAS-backed returns, tag replay and signature computation are cache concerns and are absent here; every step runs.
Source: builder/lib/tasks/runTask.js, line 181
Methods
(static) default(defineTask, parameters) → {Promise<undefined>}
Description: Runs a UI5 Builder task without a build cache.
Source: builder/lib/tasks/runTask.js, line 228
Parameters:
| Name | Type | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
defineTask | function | Task factory defineTask(options) => descriptor | ||||||||||||||||||||
parameters | object | Properties:
|
Returns:
Resolves once the task has run and all writes are complete
Type: Promise<undefined>
Type Definitions
TaskDescriptor
Description: The descriptor a task factory returns from its default export, from Specification Version 5.0. It carries the whole task in one object: the task body, its optional callbacks, and an optional declared Specification Version.
The factory must stay pure and cheap. UI5 CLI calls it once per build, early also for the build signature, so it must not read or write resources, and it must not import heavy processors. The work happens in the task body or in the step callbacks.
Source: builder/lib/tasks/runTask.js, line 199
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
steps | Array<object> | optional | The build steps of a cache-aware, step-based task. Give exactly one ofsteps or task. A step is a scalar step {name, needs?, run} or amap step {name, needs?, sequential?, keys, each}; the build cache re-runs only the steps,and within a map step only the keys, whose inputs changed. | |
task | function | optional | The task body async (parameters) => Promise<undefined> of atraditional task. Give exactly one of steps or task. | |
requiresDependencies | boolean | optional | false | Whether the task needs access to the resources of the project's dependencies. When false, the dependencies reader is not provided. |
determineRequiredDependencies | function | optional | Optional callback that reduces the set of dependencies made available through the dependencies reader. | |
determineBuildSignature | function | optional | Optional callback that contributes to the project's build signature, so a change outside the project's own resources can invalidate the task's cached output. | |
determineExpectedOutput | function | optional | Optional callback that declares the task's expected output. | |
specVersion | string | optional | Optional Specification Version. When set, it must be equal to the task extension's configured Specification Version. |
The descriptor a task factory returns from its default export, from Specification Version 5.0. It carries the whole task in one object: the task body, its optional callbacks, and an optional declared Specification Version.
The factory must stay pure and cheap. UI5 CLI calls it once per build, early also for the build signature, so it must not read or write resources, and it must not import heavy processors. The work happens in the task body or in the step callbacks.
Type:
- object