vault

package
v0.1.1 Latest Latest
Warning

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

Go to latest
Published: Apr 28, 2026 License: MIT Imports: 27 Imported by: 0

Documentation

Overview

Package vault is a placeholder for Obsite vault access.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func BuildIndexWithConcurrency

func BuildIndexWithConcurrency(scanResult ScanResult, frontmatterResult FrontmatterResult, diagCollector *diag.Collector, concurrency int) (*model.VaultIndex, error)

BuildIndexWithConcurrency applies bounded per-note concurrency during pass 1 while preserving the shared parser and immutable VaultIndex handoff.

Types

type FrontmatterResult

type FrontmatterResult struct {
	PublicNotes []*model.Note
	Unpublished model.UnpublishedLookup
}

FrontmatterResult is the Step 12 handoff for later slugging and AST indexing. PublicNotes retains the notes allowed into the public site, while Unpublished keeps the minimal resolver-facing metadata for filtered notes.

func ParseFrontmatter

func ParseFrontmatter(scanResult ScanResult, cfg model.SiteConfig) (FrontmatterResult, error)

ParseFrontmatter reads each scanned Markdown file, extracts YAML frontmatter when present, and partitions notes according to publish/defaultPublish.

type ScanResult

type ScanResult struct {
	VaultPath            string
	AttachmentFolderPath string
	MarkdownFiles        []string
	ResourceFiles        []string
	// contains filtered or unexported fields
}

ScanResult is the Step 11 handoff for later frontmatter parsing and index building. It captures the candidate Markdown files, candidate resources, and the normalized Obsidian attachment folder setting when present.

func Scan

func Scan(vaultPath string) (ScanResult, error)

Scan walks a vault once and returns the Markdown and resource candidates needed by later phases. Hidden entries, node_modules, all .obsidian content except the separately-read app.json, symlinks, and non-regular files are excluded. attachmentFolderPath is preserved as normalized metadata only and does not relax scan boundaries.

func (ScanResult) LookupResourcePath

func (r ScanResult) LookupResourcePath(relPath string) model.PathLookupResult

LookupResourcePath returns the scanned vault-relative resource path that matches relPath after exact and canonical Unicode lookup.

Jump to

Keyboard shortcuts

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