Skip to content

@pumpkin-plugins/codemod API / update-build / runUpdateBuild

Function: runUpdateBuild() ​

runUpdateBuild(paths?, options?): Promise<CodemodRunReport>

Defined in: update-build.ts:44

Resolves the installed builder, fetches npm's latest release, and runs selected migrations.

Parameters ​

paths? ​

readonly string[] = []

Files or directories selected by the caller.

options? ​

UpdateBuildOptions = {}

Project, lookup, migration, and write configuration.

Returns ​

Promise<CodemodRunReport>

Preview or write report from the shared codemod runner.

Throws ​

If the installed builder or latest release cannot be determined, or npm's latest release predates the installed version.

pumpkin-plugins documentation