highlights

package
v0.6.1017-dev.2 Latest Latest
Warning

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

Go to latest
Published: Nov 1, 2026 License: MIT Imports: 9 Imported by: 0

Documentation

Overview

Package highlights is what each release of the agentry CLI brings, in a few plain lines for the person using it. The release's notes and the download page carry them; the CLI itself prints nothing of them.

highlights.json is compiled in so that its test can hold every entry to the rules below on every build.

Index

Constants

View Source
const (
	MaxLines      = 4
	MaxLineLength = 120
)

MaxLines is how many lines one version may carry, and MaxLineLength how long each may be, in characters.

Variables

This section is empty.

Functions

func CheckLine

func CheckLine(line string) error

CheckLine says why a line cannot be a highlight, or nil. A line is one plain sentence for someone using the CLI, ending in a full stop, a question mark or an exclamation mark.

Types

type Entry

type Entry struct {
	Version    string   `json:"version"`
	Highlights []string `json:"highlights"`
}

Entry is one version's highlights. Version is X.Y.Z: every dev prerelease of a version shares its entry.

func All

func All() ([]Entry, error)

All is every version's entry, newest first. An error means the compiled file breaks its own rules, which its test refuses before a build.

func Parse

func Parse(data []byte) ([]Entry, error)

Parse reads a highlights file and checks every rule: versions are X.Y.Z, newest first, each once, with one to MaxLines lines that CheckLine accepts.

Jump to

Keyboard shortcuts

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