Package org.openrewrite.codemods

Class NodeBasedRecipe

java.lang.Object

org.openrewrite.Recipe

org.openrewrite.ScanningRecipe<NodeBasedRecipe.Accumulator>

org.openrewrite.codemods.NodeBasedRecipe

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

ApplyCodemod, Biome, ESLint, Putout, ReactI18Next, UI5

public abstract class NodeBasedRecipe
extends org.openrewrite.ScanningRecipe<NodeBasedRecipe.Accumulator>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NodeBasedRecipe.Accumulator

Nested classes/interfaces inherited from class org.openrewrite.Recipe

org.openrewrite.Recipe.Builder, org.openrewrite.Recipe.DelegatingRecipe

Field Summary

Fields inherited from class org.openrewrite.Recipe

contributors, examples, PANIC

Constructor Summary

Constructors

Constructor	Description
NodeBasedRecipe()

Method Summary

Modifier and Type	Method	Description
protected org.openrewrite.SourceFile	createAfter(org.openrewrite.SourceFile before, NodeBasedRecipe.Accumulator acc, org.openrewrite.ExecutionContext ctx)
protected static Path	createDirectory(org.openrewrite.ExecutionContext ctx, String prefix)
Collection<? extends org.openrewrite.SourceFile>	generate(NodeBasedRecipe.Accumulator acc, org.openrewrite.ExecutionContext ctx)
protected Map<String,String>	getCommandEnvironment(NodeBasedRecipe.Accumulator acc, org.openrewrite.ExecutionContext ctx)
NodeBasedRecipe.Accumulator	getInitialValue(org.openrewrite.ExecutionContext ctx)
protected abstract List<String>	getNpmCommand(NodeBasedRecipe.Accumulator acc, org.openrewrite.ExecutionContext ctx)
org.openrewrite.TreeVisitor<?,org.openrewrite.ExecutionContext>	getScanner(NodeBasedRecipe.Accumulator acc)
org.openrewrite.TreeVisitor<?,org.openrewrite.ExecutionContext>	getVisitor(NodeBasedRecipe.Accumulator acc)
protected void	processOutput(Path out, NodeBasedRecipe.Accumulator acc, org.openrewrite.ExecutionContext ctx)
protected void	runNode(NodeBasedRecipe.Accumulator acc, org.openrewrite.ExecutionContext ctx)

Methods inherited from class org.openrewrite.ScanningRecipe

generate, getAccumulator, getVisitor

Methods inherited from class org.openrewrite.Recipe

addDataTable, builder, buildRecipeList, causesAnotherCycle, clone, createRecipeDescriptor, equals, getContributors, getDataTableDescriptors, getDescription, getDescriptor, getDisplayName, getEstimatedEffortPerOccurrence, getExamples, getInstanceName, getInstanceNameSuffix, getJacksonPolymorphicTypeTag, getMaintainers, getName, getRecipeList, getTags, hashCode, maxCycles, noop, onComplete, run, run, run, setContributors, setExamples, validate, validate, validateAll, validateAll

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Details

NodeBasedRecipe

public NodeBasedRecipe()

Method Details

getInitialValue

public NodeBasedRecipe.Accumulator getInitialValue(org.openrewrite.ExecutionContext ctx)

Specified by:

getInitialValue in class org.openrewrite.ScanningRecipe<NodeBasedRecipe.Accumulator>

getScanner

public org.openrewrite.TreeVisitor<?,org.openrewrite.ExecutionContext> getScanner(NodeBasedRecipe.Accumulator acc)

Specified by:

getScanner in class org.openrewrite.ScanningRecipe<NodeBasedRecipe.Accumulator>

generate

public Collection<? extends org.openrewrite.SourceFile> generate(NodeBasedRecipe.Accumulator acc,
 org.openrewrite.ExecutionContext ctx)

Overrides:

generate in class org.openrewrite.ScanningRecipe<NodeBasedRecipe.Accumulator>

runNode

protected void runNode(NodeBasedRecipe.Accumulator acc,
 org.openrewrite.ExecutionContext ctx)

getNpmCommand

protected abstract List<String> getNpmCommand(NodeBasedRecipe.Accumulator acc,
 org.openrewrite.ExecutionContext ctx)

getCommandEnvironment

protected Map<String,String> getCommandEnvironment(NodeBasedRecipe.Accumulator acc,
 org.openrewrite.ExecutionContext ctx)

processOutput

protected void processOutput(Path out,
 NodeBasedRecipe.Accumulator acc,
 org.openrewrite.ExecutionContext ctx)

getVisitor

public org.openrewrite.TreeVisitor<?,org.openrewrite.ExecutionContext> getVisitor(NodeBasedRecipe.Accumulator acc)

Overrides:

getVisitor in class org.openrewrite.ScanningRecipe<NodeBasedRecipe.Accumulator>

createAfter

protected org.openrewrite.SourceFile createAfter(org.openrewrite.SourceFile before,
 NodeBasedRecipe.Accumulator acc,
 org.openrewrite.ExecutionContext ctx)

createDirectory

protected static Path createDirectory(org.openrewrite.ExecutionContext ctx,
 String prefix)