Help us shape the future of Go! Take the 2026 Go Developer Survey

catalog

package
v0.3.0 Latest Latest
Warning

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

Go to latest
Published: Oct 16, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Overview

Package catalog charge et valide le catalogue d'erreurs Docker embarqué, dont le contenu pédagogique est rédigé en français.

Index

Constants

This section is empty.

Variables

View Source
var Categories = map[Category]bool{
	"network": true, "image": true, "container": true, "volume": true, "daemon": true,
	"permission": true, "build": true, "compose": true, "runtime": true, "cmdline": true,
	"exited": true,
}

Catégories autorisées.

Functions

func Render

func Render(tpl string, captures map[string]string) string

Render remplit un gabarit avec les valeurs capturées. Une valeur absente est rendue par « … » plutôt que par une chaîne vide.

Types

type AntiPatternNote

type AntiPatternNote struct {
	Description string `yaml:"description"`
}

AntiPatternNote met en garde contre une solution rapide mais dangereuse.

type Catalog

type Catalog struct {
	Entries []*Entry
	// contains filtered or unexported fields
}

Catalog est l'ensemble des entrées, dans l'ordre des fichiers puis de déclaration.

func Default

func Default() (*Catalog, error)

Default charge le catalogue embarqué dans le binaire.

func Load

func Load(fsys fs.FS) (*Catalog, error)

Load charge et valide tous les fichiers *.yaml de fsys.

func (*Catalog) Get

func (c *Catalog) Get(id string) (*Entry, bool)

Get renvoie l'entrée d'identifiant id.

type Category

type Category string

Category regroupe les erreurs par domaine Docker.

type ConceptRef

type ConceptRef struct {
	Name       string `yaml:"name"`
	Definition string `yaml:"definition"`
}

ConceptRef est le concept Docker enseigné : terme d'origine et définition en français.

type Deepening

type Deepening struct {
	Explanation string `yaml:"explanation"`
	Example     string `yaml:"example"`
	Exercise    string `yaml:"exercise"`
}

Deepening est le contenu d'approfondissement (docker telemach deepen).

type Entry

type Entry struct {
	ID          string           `yaml:"id"`
	Category    Category         `yaml:"category"`
	Applies     []string         `yaml:"applies"`
	ExitCodes   []int            `yaml:"exit_codes"`
	Fallback    string           `yaml:"fallback"` // « application » : repli pour cette origine ; « compose-issue » : pédagogie d'un problème Compose ; « cmdline » : piège de ligne de commande
	Severity    string           `yaml:"severity"` // pièges de ligne de commande seulement : « warning » ou « info »
	Patterns    []string         `yaml:"patterns"`
	Concept     ConceptRef       `yaml:"concept"`
	Summary     string           `yaml:"summary"`
	Cause       string           `yaml:"cause"`
	Fixes       []Fix            `yaml:"fixes"`
	AntiPattern *AntiPatternNote `yaml:"anti_pattern"`
	Deepen      Deepening        `yaml:"deepen"`
	DocURL      string           `yaml:"doc_url"`
	Tests       []string         `yaml:"tests"`
	// contains filtered or unexported fields
}

Entry est une entrée du catalogue d'erreurs. Les textes sont en français et peuvent utiliser les valeurs capturées par les motifs, par exemple {{.port}}.

func (*Entry) Compiled

func (e *Entry) Compiled() []*regexp.Regexp

Compiled renvoie les motifs compilés de l'entrée.

type Fix

type Fix struct {
	Description string `yaml:"description"`
	Command     string `yaml:"command"`
	Safe        bool   `yaml:"safe"`
}

Fix est une action corrective. Command est un gabarit facultatif ; Safe vaut false pour une solution rapide mais dangereuse, alors présentée comme anti-pattern.

Jump to

Keyboard shortcuts

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