/*
Copyright 2020 The Kubernetes Authors.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package machinery

// IfExistsAction determines what to do if the scaffold file already exists
type IfExistsAction int

const (
	// SkipFile skips the file and moves to the next one
	SkipFile IfExistsAction = iota

	// Error returns an error and stops processing
	Error

	// OverwriteFile truncates and overwrites the existing file
	OverwriteFile
)

// IfNotExistsAction determines what to do if a file to be updated does not exist
type IfNotExistsAction int

const (
	// ErrorIfNotExist returns an error and stops processing (default behavior)
	ErrorIfNotExist IfNotExistsAction = iota

	// IgnoreFile skips the file and logs a message if it does not exist
	IgnoreFile
)

// File describes a file that will be written
type File struct {
	// Path is the file to write
	Path string

	// Contents is the generated output
	Contents string

	// IfExistsAction determines what to do if the file exists
	IfExistsAction IfExistsAction

	// IfNotExistsAction determines what to do if the file is missing (optional updates only)
	IfNotExistsAction IfNotExistsAction
}
