utils

Documentation

Index

• Variables
• func EnsureSubPath(base, path string) error
• func IsSimilarWord(given string, suggestion string) bool
• func RemoveIgnoreNonExistent(file string) error

Variables

var ErrPathEscapesBase = errors.New("path escapes base directory")

ErrPathEscapesBase is returned when a path is outside the expected base directory.

Functions

func EnsureSubPath

func EnsureSubPath(base, path string) error

EnsureSubPath returns an error if path is not contained within base. This prevents path traversal attacks where user-controlled data could escape the intended directory.

func IsSimilarWord

func IsSimilarWord(given string, suggestion string) bool

IsSimilarWord calculates "The Levenshtein Distance" between two strings which represents the minimum total cost of edits that would convert the first string into the second. If the distance is less than 3, the word is considered misspelled.

func RemoveIgnoreNonExistent

func RemoveIgnoreNonExistent(file string) error

RemoveIgnoreNonExistent removes a file, ignoring if it doesn't exist.