generate

type CommentRefactor struct{}

type NonGoFileRefactor struct{}

type PackageRefactor struct {
}

type Refactor struct {
	//Name to identify the refactor
	Name string
	//Find is the string to be found
	Find string
	//Replace is the string to be replaced in the place of the string to be found
	Replace string
	//IsRegex indicates that the string to be found is a regular expression
	IsRegex bool
	//Source is the source to be refactored
	Source RefactorSource
}

type RefactorSource interface {
	//Initiate will read the given file and initiate the refactoring. Through the returned output
	//channel the code to be refactored will be streamed and through the in channel it will replace the code with the refactored one.
	//During processing of each source code stream, if any error occurs it will be pushed to the error channel. Else nil will be pushed to it.
	//The absolute path to the file from the refactor source code string has to be recovered
	//This method also returns the error if any else nil is returned
	Initiate(file string, in chan string) (chan string, chan error, error)
}

type Source struct {
	//Path is absolute path at which the source file exists
	Path string
	//FileName is the name of the source file
	FileName string
	//RelativeDestination is the relative path in the destination to put the refactored file
	RelativeDestination string
	//Refactors is the list of refactors
	Refactors []Refactor
}