fopa

package module

v0.0.0-...-a6116a0 Latest Latest Go to latest Published: May 18, 2023 License: BSD-3-Clause Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/kendfss/fopa

Links

Open Source Insights

README ¶

fopa

Forbidden Paths Sanitize a file's path so that it has consistent across common operating systems and the web.

package main

import "github.com/kendfss/fopa"

func main() {
    path := "%# "
    println(fopa.Sanitize(path)) // ___
    println(fopa.Sanitizef(path, "*")) // ***, but this is also forbidden
}

Documentation ¶

Index ¶

Variables
func Clean(path string) string
func Cleanf(path, fill string) string
func ForbiddenChars() []string
func Map[Arg, Val any](fn func(Arg) Val, args ...Arg) []Val
func Redux(path string) string
func Reduxf(path, fill string) string
func Sanitize(path string) string
func Sanitizef(path, fill string) string
type Rule
- func ForbiddenRules() []Rule

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	Filler = "_"
)

Functions ¶

func Clean ¶

func Clean(path string) string

Sanitize and Redux a filepath

func Cleanf ¶

func Cleanf(path, fill string) string

Sanitize and Redux a filepath, with a format string

func ForbiddenChars ¶

func ForbiddenChars() []string

func Map ¶

func Map[Arg, Val any](fn func(Arg) Val, args ...Arg) []Val

func Redux ¶

func Redux(path string) string

remove runs of the fill character

func Reduxf ¶

func Reduxf(path, fill string) string

remove runs of the fill character, with a format string

func Sanitize ¶

func Sanitize(path string) string

remove illegal characters from a file path

func Sanitizef ¶

func Sanitizef(path, fill string) string

remove illegal characters from a file path

Types ¶

type Rule ¶

type Rule struct {
	Symb string `json:"symb"`
	Desc string `json:"name"`
}

func ForbiddenRules ¶

func ForbiddenRules() []Rule

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
fetch

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL