board

package
v0.1.0 Latest Latest
Warning

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

Go to latest
Published: Aug 17, 2026 License: MIT Imports: 3 Imported by: 0

Documentation

Overview

Package board holds the logic for making a freshly created board private and telling the agents that work in this repository about it. It depends only on the stdlib so both internal/cli and internal/tui can call it without a cycle.

Index

Constants

View Source
const IgnoreLine = "/.jaira/"

IgnoreLine is the entry that keeps a board private.

View Source
const LanesIgnoreLine = "/.jaira/lanes/"

LanesIgnoreLine keeps a project's own lane directory out of git even once the rest of the board is shared. .jaira/lanes/ is scoped to this machine (see D-03) and was never meant to reach a teammate. This is an ordinary ignore rule on a path outside any ignored tree, not a negation pattern: by the time this line matters, RemoveIgnore has already stopped ignoring .jaira/ itself, so there is no ignored parent to negate out of.

Variables

This section is empty.

Functions

func AddIgnore

func AddIgnore(root string) (changed bool, err error)

AddIgnore keeps the board out of git.

func AddLanesIgnore

func AddLanesIgnore(root string) (changed bool, err error)

AddLanesIgnore keeps this project's lane directory private, independent of whether the rest of the board is shared. Idempotent: calling it again once the line is already present reports changed=false and writes nothing.

func AnnounceInAgentFiles

func AnnounceInAgentFiles(root string) (written []string, err error)

AnnounceInAgentFiles writes the note into each agent instruction file.

func Ignored

func Ignored(root string) bool

Ignored reports whether the root .gitignore excludes the board.

func RemoveIgnore

func RemoveIgnore(root string) (changed bool, err error)

RemoveIgnore stops excluding the board.

func RemoveLanesIgnore

func RemoveLanesIgnore(root string) (changed bool, err error)

RemoveLanesIgnore removes the lanes-only ignore line. Used by 'share --undo': once the whole board is private again, /.jaira/ already covers .jaira/lanes/, and a leftover line would be a puzzle for the next reader.

Types

type Prepared

type Prepared struct {
	Ignored   bool // .gitignore gained the entry on this run
	IgnoreErr error
	Notes     []string // agent files touched, as "NAME (action)"
	NoteErr   error
}

Prepared reports what preparing a new board did.

func Prepare

func Prepare(root string) Prepared

Prepare makes a freshly created board private and tells the agents about it.

Jump to

Keyboard shortcuts

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