Documentation
¶
Overview ¶
Package compose analyse les fichiers Docker Compose, en lecture seule, pour localiser précisément les erreurs (fichier, ligne, colonne, clé).
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ErrNotFound = errors.New("aucun fichier Compose trouvé")
ErrNotFound signale qu'aucun fichier Compose n'a été trouvé.
Functions ¶
func DefaultFileNames ¶
func DefaultFileNames() []string
DefaultFileNames renvoie les noms de fichiers recherchés par défaut.
func Locate ¶
Locate renvoie les fichiers Compose à analyser : ceux passés par -f (relatifs à dir), sinon le premier nom par défaut trouvé dans dir, suivi de son fichier de surcharge. Aucun fichier n'est ouvert en écriture.
func RenderIssues ¶
func RenderIssues(w io.Writer, dir string, files []string, issues []Issue, cat *catalog.Catalog, o render.Options) error
RenderIssues affiche les problèmes Compose : emplacement, extrait coloré avec la ligne fautive mise en évidence, version corrigée, puis la pédagogie du type de problème (une seule fois par type). Sans problème, un message de succès explicite est affiché.
Types ¶
type Issue ¶
type Issue struct {
Kind Kind
File string // chemin tel qu'indiqué ou trouvé
Line int // à partir de 1 ; 0 si inconnue
Column int // à partir de 1 ; 0 si inconnue
Service string
KeyPath string // ex. services.web.port
Suggestion string // clé, valeur ou variable proposée
Detail string // précision en français (message traduit, référence manquante…)
Excerpt []render.Line
Fixed []render.Line
Blocking bool
}
Issue est un problème localisé dans un fichier Compose (data-model.md, ComposeIssue).
type Kind ¶
type Kind string
Kind est la nature d'un problème détecté dans un fichier Compose.
const ( KindYAMLSyntax Kind = "yaml-syntax" KindTabIndent Kind = "tab-indent" KindUnknownKey Kind = "unknown-key" KindWrongType Kind = "wrong-type" KindUndefinedReference Kind = "undefined-reference" KindDependencyCycle Kind = "dependency-cycle" KindUnresolvedVariable Kind = "unresolved-variable" KindPlaintextSecret Kind = "plaintext-secret" KindFileNotFound Kind = "file-not-found" KindFileUnreadable Kind = "file-unreadable" )
Source Files