filenamify

README

go-filenamify

Convert a string to a valid safe filename

Installation

$ go get github.com/flytam/filenamify

(optional) To run unit tests:

go test -v

Usage

package main
import (
	"github.com/flytam/filenamify"
	"fmt"
)

func main() {
	output,err :=filenamify.Filenamify(`<foo/bar>`,filenamify.Options{})
    fmt.Println(output,err) // => foo!bar,nil

    //---
    output,err =filenamify.Filenamify(`foo:"bar"`,filenamify.Options{
    	Replacement:"🐴",
    })
    fmt.Println(output,err) // => foo🐴bar,nil


	output,err =filenamify.FilenamifyV2(`<foo/bar>`)
    fmt.Println(output,err) // => foo!bar,nil

    //---
    output,err =filenamify.FilenamifyV2(`foo:"bar"`,func(options *Options) {
		options.Replacement = "🐴"
	})
    fmt.Println(output,err) // => foo🐴bar,nil

}

API

• Filenamify(str string, options Options) (string, error)

• func Path(filePath string, options Options) (string, error)

type Options struct {
	// String for substitution
	Replacement string// default: "!"
	// maxlength
	MaxLength int// default: 100
}

FilenamifyV2 and PathV2 are added in v1.1.0

• func FilenamifyV2(str string, optFuns ...func(options *Options)) (string, error)
• func PathV2(str string, optFuns ...func(options *Options)) (string, error)

Related

• Node-filenamify

LICENSE

MIT

Documentation

Index

• Constants
• func Filenamify(str string, options Options) (string, error)
• func FilenamifyV2(str string, optFuns ...func(options *Options)) (string, error)
• func Path(filePath string, options Options) (string, error)
• func PathV2(filePath string, optFuns ...func(options *Options)) (string, error)
• type Options

Constants

const MAX_FILENAME_LENGTH = 100

Functions

func Filenamify

func Filenamify(str string, options Options) (string, error)

func FilenamifyV2

func FilenamifyV2(str string, optFuns ...func(options *Options)) (string, error)

func Path

func Path(filePath string, options Options) (string, error)

func PathV2

func PathV2(filePath string, optFuns ...func(options *Options)) (string, error)

Types

type Options

type Options struct {
	// String for substitution
	Replacement string
	// maxlength
	MaxLength int
}