journal

package
v0.8.0 Latest Latest
Warning

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

Go to latest
Published: Mar 24, 2026 License: Apache-2.0 Imports: 0 Imported by: 0

Documentation

Overview

Package journal defines constants for journal export, site generation, and display limits.

Index

Constants

View Source
const (
	BoilerplateNoMatch    = "No matches found"
	BoilerplateFilePrefix = "The file "
	BoilerplateFileSuffix = "has been updated successfully."
	BoilerplateDenied     = "denied this tool"
)

Boilerplate detection patterns for tool output filtering. These are parser vocabulary (not i18n text) - they match Claude Code's fixed output strings.

View Source
const (
	// CheckJournalThrottleID is the state file name for daily throttle of journal checks.
	CheckJournalThrottleID = "journal-reminded"
	// CheckJournalClaudeProjectsSubdir is the relative path under $HOME to
	// the Claude Code projects directory scanned for unexported sessions.
	CheckJournalClaudeProjectsSubdir = ".claude/projects"
)

Check-journal configuration.

View Source
const (
	// PreviewMaxTurns is the maximum number of user turns shown in
	// the conversation preview of recall show.
	PreviewMaxTurns = 5
	// PreviewMaxTextLen is the maximum character length for a single
	// turn in the conversation preview.
	PreviewMaxTextLen = 100
	// SlugMaxLen is the maximum display length for session slugs in
	// recall list output.
	SlugMaxLen = 36
	// TitleSlugMaxLen is the maximum character length for title-derived
	// slugs used in journal filenames.
	TitleSlugMaxLen = 50
	// SessionIDShortLen is the prefix length for short session IDs
	// in summary output.
	SessionIDShortLen = 8
	// SessionIDHintLen is the prefix length for session IDs in
	// disambiguation hints (longer than short for uniqueness).
	SessionIDHintLen = 12
)

Recall show/list display limits.

View Source
const (
	// PopularityThreshold is the minimum number of entries to
	// mark a topic or key file as "popular" (gets its own dedicated page).
	PopularityThreshold = 2
	// LineWrapWidth is the soft wrap target column for journal
	// content.
	LineWrapWidth = 80
	// MaxRecentSessions is the maximum number of sessions shown
	// in the zensical navigation sidebar.
	MaxRecentSessions = 20
	// MaxNavTitleLen is the maximum title length before
	// truncation in the zensical navigation sidebar.
	MaxNavTitleLen = 40
	// DatePrefixLen is the length of a YYYY-MM-DD date prefix.
	DatePrefixLen = 10
	// MonthPrefixLen is the length of a YYYY-MM month prefix.
	MonthPrefixLen = 7
	// TimePrefixLen is the length of an HH:MM time prefix.
	TimePrefixLen = 5
	// MaxTitleLen is the maximum character length for a journal title.
	// Keeps H1 headings and link text on a single line (below wrap width).
	MaxTitleLen = 75
	// ShortIDLen is the truncation length for session IDs in filenames.
	ShortIDLen = 8
	// DetailsThreshold is the line count above which tool output is
	// wrapped in a collapsible <details> block.
	DetailsThreshold = 10
	// DefaultRecallListLimit is the default number of sessions shown by recall list.
	DefaultRecallListLimit = 20
	// MultipartSuffix is the separator between the base slug and the part
	// number in multipart journal filenames (e.g. "slug-p2.md").
	MultipartSuffix = "-p"
)

Journal site generation constants.

View Source
const (
	// StageExported marks a journal entry as exported from Claude Code.
	StageExported = "exported"
	// StageEnriched marks a journal entry as enriched with metadata.
	StageEnriched = "enriched"
	// StageNormalized marks a journal entry as normalized for rendering.
	StageNormalized = "normalized"
	// StageFencesVerified marks a journal entry as having verified code fences.
	StageFencesVerified = "fences_verified"
	// StageLocked marks a journal entry as locked (read-only).
	StageLocked = "locked"
)

Journal processing stage names.

View Source
const (
	// VarUnenrichedCount is the template variable for unenriched entry count.
	VarUnenrichedCount = "UnenrichedCount"
	// VarUnexportedCount is the template variable for unexported session count.
	VarUnexportedCount = "UnexportedCount"
)

Template variable keys for journal hooks.

View Source
const (
	// FileState is the processing state file in .context/journal/.
	FileState = ".state.json"
)

Journal state file.

View Source
const (
	// MaxMessagesPerPart is the maximum number of messages per exported
	// journal file. Sessions with more messages are split into multiple
	// parts for browser performance.
	MaxMessagesPerPart = 200
)

Export configuration.

View Source
const PartPrefix = "**Part "

PartPrefix is the Markdown bold prefix for multipart navigation labels.

Variables

This section is empty.

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

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