slug

README

golang-slug

This Go package makes it easy to generate slugs from human-readable text.

Example

package main

import (
	"fmt"

	slug "github.com/theTardigrade/golang-slug"
)

func main() {
	defaultOptions := slug.NewOptionsWithDefaults()
	result, err := slug.GetWithOptions("!=this is the text's slug=!", &slug.Options{
		WholeWords:    false,
		MaxLen:        20,
		Replacement:   "_",
		RunesToRemove: defaultOptions.RunesToRemove,
	})
	if err != nil {
		panic(err)
	}

	fmt.Println(result) // prints "this_is_the_texts_sl"
}

Support

If you use this package, or find any value in it, please consider donating:

Documentation

Index

• Variables
• func Get(text string) (slug string, err error)
• func GetWithOptions(text string, options *Options) (slug string, err error)
• type Options
  • func NewOptionsWithDefaults() *Options

Variables

var (
	ErrUniqueAttempts = errors.New("too many unique slugs attempted with no success")
	ErrUniqueLength   = errors.New("not enough length to make all unique attempts")
)

Functions

func Get

func Get(text string) (slug string, err error)

func GetWithOptions

func GetWithOptions(text string, options *Options) (slug string, err error)

Types

type Options

type Options struct {
	MaxLen         int
	Replacement    string
	RunesToRemove  []rune
	WholeWords     bool
	Unique         bool
	UniqueAttempts int
}

func NewOptionsWithDefaults

func NewOptionsWithDefaults() *Options