slug

package

v0.1.1 Latest Latest Go to latest Published: Apr 28, 2026 License: MIT Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/simp-lee/obsite

Links

Open Source Insights

Documentation ¶

Overview ¶

Package slug lowercases and NFC-normalizes note slugs, rejects inputs that normalize to empty, and detects slug conflicts using the same canonical form.

Index ¶

Variables
func Canonicalize(input string) string
func DetectConflicts(candidates []Candidate) ([]Conflict, []InvalidSlug)
func Generate(frontmatterSlug *string, relPath string) (string, error)
type Candidate
type Conflict
type InvalidSlug

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ErrInvalidFrontmatterSlug reports an explicit frontmatter slug that normalizes to empty.
	ErrInvalidFrontmatterSlug = errors.New("frontmatter slug normalizes to empty")
	// ErrInvalidFileSlug reports a file stem that normalizes to empty.
	ErrInvalidFileSlug = errors.New("file stem normalizes to empty")
)

Functions ¶

func Canonicalize ¶

func Canonicalize(input string) string

Canonicalize returns the shared lowercase NFC form used by slug generation and note or alias lookup keys.

func DetectConflicts ¶

func DetectConflicts(candidates []Candidate) ([]Conflict, []InvalidSlug)

DetectConflicts returns stable lists of slug conflicts and invalid empty slugs.

func Generate ¶

func Generate(frontmatterSlug *string, relPath string) (string, error)

Generate returns the normalized slug for a note.

If frontmatterSlug is provided, it is authoritative. Otherwise the file stem from relPath is used. Inputs that normalize to empty are rejected.

Types ¶

type Candidate ¶

type Candidate struct {
	Source string
	Slug   string
}

Candidate identifies a source path and the slug assigned to it.

type Conflict ¶

type Conflict struct {
	Slug    string
	Sources []string
}

Conflict reports a slug used by multiple sources.

type InvalidSlug ¶

type InvalidSlug struct {
	Source string
	Slug   string
}

InvalidSlug reports a source whose slug is empty or whitespace-only.

Source Files ¶

View all Source files

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