sanitizefilename

README

SanitizeFilename

A handy utility function that will sanitize a given filename string based on the current OS detected by the runtime.

Installation

go get github.com/jacoblockett/sanitizefilename

You can read the godoc here for detailed documentation.

Quickstart

package main

import "github.com/jacoblockett/sanitizefilename"

func main() {
	// Assuming a Windows environment
	filename := "<>:\"/\\|?*abc.txt" // "<>:"/\|?*abc.txt" without escape chars
	sanitized := sanitizefilename.Sanitize(filename)

	fmt.Println(sanitized) // "abc.txt"

	// Assuming a Linux/Unix environment
	filename := "/.."
	sanitized := sanitizefilename.Sanitize(filename)

	fmt.Println(sanitized) // ""
}

Documentation

Index

• func Sanitize(filename string) string

Functions

func Sanitize

func Sanitize(filename string) string

Sanitizes the given string under the assumption it represents a filename. Sanitation is OS-agnostic.