apply

Documentation

Overview

Package apply provides functionality to execute declarative change plans. It handles the parsing of JSON-based plans and the execution of steps such as file modifications and command execution.

Index

• type ChangePlan
• type Step

Types

type ChangePlan

type ChangePlan struct {
	Description string `json:"description"`
	Steps       []Step `json:"steps"`
}

ChangePlan defines the top-level structure for a declarative plan.

type Step

type Step struct {
	Type        string `json:"type"`
	Description string `json:"description"`

	// Fields for "file_modification" type
	Changes codemod.ChangeScript `json:"changes,omitempty"`

	// Fields for "command_execution" type
	Command string   `json:"command,omitempty"`
	Args    []string `json:"args,omitempty"`
}

Step represents a single action in the ChangePlan.