report

Documentation

Overview

Package report provides details about the renaming operation in table or json format

Index

• Variables
• func BackupFailed(err error)
• func Conflicts(conflicts conflict.Collection, jsonOut bool)
• func Interactive(fileChanges []*file.Change)
• func JSON(fileChanges []*file.Change)
• func NoMatches(jsonOut bool)
• func NonInteractive(fileChanges []*file.Change)

Variables

var (
	Stdout io.Writer = os.Stdout
	Stderr io.Writer = os.Stderr
)

Functions

func BackupFailed

func BackupFailed(err error)

func Conflicts

func Conflicts(conflicts conflict.Collection, jsonOut bool)

Conflicts prints any detected conflicts to the standard output in table format.

func Interactive

func Interactive(
	fileChanges []*file.Change,
)

Interactive prints the changes to be made and prompts the user to commit the changes. Blocks unti user types ENTER.

func JSON

func JSON(
	fileChanges []*file.Change,
)

JSON displays the renaming changes to be made in JSON format.

func NoMatches

func NoMatches(jsonOut bool)

NoMatches prints out a message indicating that the find string failed to match any files.

func NonInteractive

func NonInteractive(
	fileChanges []*file.Change,
)

NonInteractive prints a report of the renaming changes to be made without prompting the user.