codemod

Documentation

Index

• func ApplyEdits(edits []Edit) (applied int, filesModified int, err error)
• type Edit
  • func EditsForFile(path string, recipe Recipe) ([]Edit, error)
• type Recipe
  • func LoadRecipe(path string) (Recipe, error)
  • func (r Recipe) Validate() error
• type Result
  • func Run(root string, recipe Recipe, apply bool) (Result, error)

Functions

func ApplyEdits

func ApplyEdits(edits []Edit) (applied int, filesModified int, err error)

Types

type Edit

type Edit struct {
	File        string
	StartByte   int
	EndByte     int
	Replacement string
}

func EditsForFile

func EditsForFile(path string, recipe Recipe) ([]Edit, error)

type Recipe

type Recipe struct {
	Name        string `yaml:"name"`
	Language    string `yaml:"language"`
	Match       string `yaml:"match"`
	Replacement string `yaml:"replacement"`
}

func LoadRecipe

func LoadRecipe(path string) (Recipe, error)

func (Recipe) Validate

func (r Recipe) Validate() error

type Result

type Result struct {
	Matches       int
	FilesMatched  int
	EditsApplied  int
	FilesModified int
	Edits         []Edit
}

func Run

func Run(root string, recipe Recipe, apply bool) (Result, error)