conventions

package
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 17, 2026 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package conventions matches file paths to project documentation and provides browsing of convention definitions.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BuildIndex

func BuildIndex(ctx context.Context, cfg *config.Config) search.Searcher

BuildIndex creates a search index from the conventions map. Conventions are indexed independently so they are always surfaced prominently in search results, regardless of BM25 scores from source docs.

func ForPath

func ForPath(conventions map[string]config.Convention, path string) []config.Convention

ForPath returns conventions from the given map that match path. Conventions with no scope are skipped; they are search-only. Scopes support glob patterns: ** matches any depth, * matches within a single path segment, and a bare * matches any path.

Types

This section is empty.

Jump to

Keyboard shortcuts

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