identity

Documentation

Overview

Package identity implements lore's typed-prefix source identity scheme, decided in https://github.com/cheetahbyte/lore/issues/8.

Index

• type ID
  • func New(t SourceType, ref string) ID
  • func Parse(s string) (ID, error)
  • func (id ID) Ref() string
  • func (id ID) String() string
  • func (id ID) Type() SourceType
• type SourceType

Types

type ID

type ID string

ID is a canonical typed-prefix identity, e.g. "github:owner/repo" or "npm:react". The prefix names the Source adapter that owns it; the remainder is that adapter's own reference format.

func New

func New(t SourceType, ref string) ID

New builds an ID from a known type and reference without validating the reference's own format (that's the owning adapter's job).

func Parse

func Parse(s string) (ID, error)

Parse validates and returns s as an ID. s must contain a known type prefix followed by ":" and a non-empty reference.

func (ID) Ref

func (id ID) Ref() string

Ref returns the identity's reference, i.e. everything after the first ":".

func (ID) String

func (id ID) String() string

func (ID) Type

func (id ID) Type() SourceType

Type returns the identity's source-type prefix.

type SourceType

type SourceType string

const (
	GitHub    SourceType = "github"
	NPM       SourceType = "npm"
	PyPI      SourceType = "pypi"
	GoPackage SourceType = "pkg.go.dev"
	LLMsTxt   SourceType = "llms-txt"
	URL       SourceType = "url"
)