@pumpkin-plugins/codemod API / runner / runCodemod

Function: runCodemod()

runCodemod(codemod, inputs, options?): Promise<CodemodRunReport>

Defined in: runner.ts:19

Finds matching files, transforms them, and writes changes only when requested.

Parameters

codemod

CodemodDefinition

inputs

readonly string[]

options?

RunCodemodOptions = {}

Returns

Promise<CodemodRunReport>

Throws

If an input path cannot be read, a transform fails or a write fails. Write errors include any files already updated in the run.