<!-- Please make sure you have read the submission guidelines before posting an PR --> <!-- https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#-submitting-a-pr --> <!-- Please make sure that your commit message follows our format --> <!-- Example: `fix(nx): must begin with lowercase` --> <!-- If this is a particularly complex change or feature addition, you can request a dedicated Nx release for this pull request branch. Mention someone from the Nx team or the `@nrwl/nx-pipelines-reviewers` and they will confirm if the PR warrants its own release for testing purposes, and generate it for you if appropriate. --> ## Current Behavior <!-- This is the behavior we have today --> There is no specific API for running things before and after tasks run. ## Expected Behavior <!-- This is the behavior we should expect with the changes in this PR --> This PR adds an API akin to npm's `preinstall` and `postinstall`. Plugins can now specify `preTasksExecution` and `postTasksExecution` functions which run before and after Nx runs tasks respectively. ```ts import type { PreTasksExecutionContext, PostTasksExecutionContext } from '@nx/devkit'; interface PluginOptions { field: any; } export function preTasksExecution(options: PluginOptions, context: PreTasksExecutionContext) { console.log('prerun') } export function postTasksExecution(options: PluginOptions, context: PostTasksExecutionContext) { console.log('postrun', context.taskResults) } ``` ## Related Issue(s) <!-- Please link the issue being fixed so it gets closed when this is merged. --> Fixes #
25 lines
874 B
Markdown
25 lines
874 B
Markdown
# Type alias: PreTasksExecution\<TOptions\>
|
|
|
|
Ƭ **PreTasksExecution**\<`TOptions`\>: (`options`: `TOptions` \| `undefined`, `context`: [`PreTasksExecutionContext`](../../devkit/documents/PreTasksExecutionContext)) => `void` \| `Promise`\<`void`\>
|
|
|
|
#### Type parameters
|
|
|
|
| Name | Type |
|
|
| :--------- | :-------- |
|
|
| `TOptions` | `unknown` |
|
|
|
|
#### Type declaration
|
|
|
|
▸ (`options`, `context`): `void` \| `Promise`\<`void`\>
|
|
|
|
##### Parameters
|
|
|
|
| Name | Type |
|
|
| :-------- | :---------------------------------------------------------------------------- |
|
|
| `options` | `TOptions` \| `undefined` |
|
|
| `context` | [`PreTasksExecutionContext`](../../devkit/documents/PreTasksExecutionContext) |
|
|
|
|
##### Returns
|
|
|
|
`void` \| `Promise`\<`void`\>
|