Slug Craft

Why SlugCraft?

• 🌍 Multilingual Magic: Smart transliteration for non-Latin scripts (e.g., "привет" → "privet").
• ⚡ Blazing Fast: Zero-allocation options and bulk processing for scale.
• 🛠️ Configurable: Build your own slug pipeline with ease.
• 🚀 Unique Slugs: Collision avoidance with timestamps, UUIDs, or custom suffixes.
• ✨ SEO & UX Ready: Human-readable, meaningful slugs out of the box.

Say goodbye to boring, brittle slug libraries. SlugCraft is here to level up your Go projects.

Package Installation

To use SlugCraft as a library in your Go project, install it with:

go get github.com/mnuddindev/slugcraft@latest

Example

package main

import (
	"context"
	"fmt"
	"github.com/mnuddindev/slugcraft"
)

func main() {
	s := slugcraft.New(
		slugcraft.WithLanguage("bn"),
		slugcraft.WithStopwords("en"),
		slugcraft.WithAbbreviation("বাংলা", "BN"),
	)
	slug, err := s.Make(context.Background(), "বাংলা the World")
	if err != nil {
		fmt.Println("Error:", err)
		return
	}
	fmt.Println(slug) // Output: "bn-world"
}

CLI Installation

To install the SlugCraft CLI tool globally on your machine, use:

go install github.com/mnuddindev/slugcraft/cmd/slugcraft@latest

CLI Usage

Generate slugs directly from the command line:

slugcraft -input "বাংলা প্রিয়" -lang=bn

output: bangla-priyo

Available Flags

Available Flags
    -input string: Text to slugify (required)
    -lang string: Language (e.g., bn, ru; optional)
    -cache bool: Enable cache for uniqueness (default: false)
    -suffix string: Suffix style (numeric, version, revision; default: numeric)
    -max int: Maximum slug length (default: 100)
    -stopwords string: Language for stopwords (e.g., en; optional)
    -regex string: Regex filter pattern (e.g., [^a-z0-9-]) (optional)
    -replace string: Regex replacement (default: "")
    -abbr string: Abbreviations (e.g., বাংলা=BN,আমি=ME) (optional)
	-zeroalloc bool: Enable zero allocation method to generate (default: true)
	-file string: Get file name and path to generate slug from file concurrently
    -help: Show usage info

CLI Examples

# English with stopwords and regex
slugcraft -input "Hello the World!" -stopwords=en -regex="[^a-z0-9-]" -replace=""
# Output: hello-world

# Bangla with abbreviations
slugcraft -input "বাংলা আমি" -lang=bn -abbr="বাংলা=BN,আমি=ME"
# Output: bn-me

License

The source files are distributed under the the Massachusetts Institute of Technology, unless otherwise noted.