$ reference
Filtres TOML
~/.boost/filters/ ou .boost/filters/ — sans recompilation. Où les filtres se chargent
Boost fusionne les filtres de plusieurs emplacements et applique chaque filtre sélectionné par la commande ou la sortie. Les fichiers d'un dossier se chargent dans un ordre déterministe.
- Filtres intégrés livrés avec Boost (
make,terraform,shellcheck, …) ~/.boost/filters/*.toml(dossier global, un filtre par fichier).boost/filters/*.tomldans le projet (dossier, un filtre par fichier)
Les sources sont fusionnées, pas remplacées. Un filtre projet ne remplace pas un filtre intégré du même nom — les deux se chargent (nom + source), et chaque filtre dont match_command ou match_output_select correspond s'applique dans l'ordre (builtin → global → project). Pour remplacer un intégré, désactivez-le avec boost filters disable et publiez le vôtre.
Disposition des dossiers (un filtre par fichier)
Les filtres personnalisés vivent dans des fichiers à un seul filtre : chaque fichier contient un bloc [filters.<name>] et des exemples [[tests.<name>]].
~/.boost/filters/
git-status.toml # [filters.git-status] + [[tests.git-status]]
my-deploy.toml # [filters.my-deploy] + [[tests.my-deploy]]Les filtres dans ~/.boost/filters/ sont pris en charge au prochain processus boost sans recompilation.
Sélecteurs et champs courants
Chaque filtre a besoin d'au moins un sélecteur. Ces champs apparaissent dans presque tous les exemples ; le glossaire complet est en bas de page.
| Champ | Rôle |
|---|---|
| match_command | Select by command line (capture path) |
| match_output_select | Select by piped output signature (hook path); use (?m) for line anchors |
| strip_ansi | Remove terminal color codes first |
| strip_lines_matching | Drop lines matching any pattern |
| keep_lines_matching | Keep only matching lines |
| on_empty | Message when filtering removes everything |
Variante regex
Tous les motifs utilisent le paquet regexp de Go (syntaxe RE2), pas PCRE. Pas de backreferences ni de lookbehind. Les ancres multilignes ^/$ nécessitent (?m). Voir regexp/syntax.
Exemple : script de déploiement personnalisé
Votre équipe exécute ./scripts/deploy.sh via Boost. Le hook n'envoie que la sortie, donc match_output_select est nécessaire en plus de match_command.
.boost/filters/deploy.toml
schema_version = 1
[filters.deploy]
description = "Keep failures from deploy.sh"
version = "1"
match_command = '(?:^|[;&|]\s*)(?:bash\s+)?(?:\S*/)?deploy\.sh\b'
# The hook pipes output to boost, so select by a distinctive output signature.
# (?m) makes ^ and $ match each line, not only the full output boundaries.
match_output_select = [
'(?m)^Starting deployment$\n^Environment: ',
]
strip_ansi = true
keep_lines_matching = [
'^Starting deployment$',
'^Environment: ',
'^\[(WARN|ERROR)\]',
'^ERROR DETAILS:$',
'failed readiness probe',
'^File:$',
'^deploy/check_health\.go:\d+$',
'^Reason:$',
'^connection refused',
'^Rollback started\.\.\.$',
'^Deployment FAILED$',
]
[[tests.deploy]]
name = "keeps failures, drops info chatter"
input = """
Starting deployment
Environment: staging
[INFO] Waiting for rollout
[WARN] High memory usage detected
[ERROR] Deployment validation failed
ERROR DETAILS:
service payment-service failed readiness probe
File:
deploy/check_health.go:142
Reason:
connection refused to database
Rollback started...
Deployment FAILED
Environment: staging
"""
expected = """
Starting deployment
Environment: staging
[WARN] High memory usage detected
[ERROR] Deployment validation failed
ERROR DETAILS:
service payment-service failed readiness probe
File:
deploy/check_health.go:142
Reason:
connection refused to database
Rollback started...
Deployment FAILED
Environment: staging
"""Starting deployment Environment: staging [INFO] Waiting for rollout [WARN] High memory usage detected [ERROR] Deployment validation failed ERROR DETAILS: service payment-service failed readiness probe File: deploy/check_health.go:142 Reason: connection refused to database Rollback started... Deployment FAILED Environment: staging
Starting deployment Environment: staging [WARN] High memory usage detected [ERROR] Deployment validation failed ERROR DETAILS: service payment-service failed readiness probe File: deploy/check_health.go:142 Reason: connection refused to database Rollback started... Deployment FAILED Environment: staging
$ ./scripts/deploy.sh staging # the installed Boost hook pipes output automatically
Tests inline
Chaque bloc [[tests.<name>]] est un fixture de régression : name, input et expected. expect_match_output optionnel vérifie la sélection via match_output_select.
Comment les exécuter
Il n'y a pas encore de boost filters test. Vérifiez les filtres personnalisés en envoyant un échantillon via boost. Les fixtures intégrés tournent avec go test :
# Spot-check a custom filter: pipe sample output through boost
printf '%s\n' 'Starting deployment' 'Environment: staging' '[INFO] noise' | boost
# Built-in [[tests.*]] fixtures run in the Boost repo / CI:
go test ./internal/tomlfilter/ -run TestInlineTestDefsExemple : réduire le bruit make
Les filtres intégrés utilisent le même schéma. Ceci reflète le filtre make livré : supprime les lignes d'entrée/sortie de répertoire et les lignes vides.
schema_version = 1
[filters.make]
match_command = "^make\\b"
match_output_select = [
"^make\\[\\d+\\]:",
"^gcc ",
]
strip_lines_matching = [
"^make\\[\\d+\\]:",
"^\\s*$",
"^Nothing to be done",
]
on_empty = "make: ok"make[1]: Entering directory '/home/user/app' gcc -O2 -c src/main.c gcc -O2 -o app src/main.o make[1]: Leaving directory '/home/user/app'
gcc -O2 -c src/main.c gcc -O2 -o app src/main.o
Exemple : court-circuit sur lint propre
Utilisez match_output pour renvoyer un résumé d'une ligne quand l'outil a réussi silencieusement.
schema_version = 1
[filters.eslint-quiet]
match_command = "^eslint\\b"
match_output_select = [
"problems",
]
match_output = [
{ pattern = "0 problems", message = "eslint: ok" },
]Désactiver un filtre
Préférez la CLI :
boost filters show # inventory with enabled/disabled status
boost filters show --enabled # enabled filters only
boost filters disable git-status # bare name or toml:builtin:git-status
boost filters enable git-statusOu éditez ~/.boost/config.toml directement — listez les noms sous [filters] disabled. Après retrieve_disable_threshold événements retrieve (défaut 3), boost retrieve ajoute automatiquement les noms rollback. Mettez 0 pour désactiver l'auto-disable.
[filters]
disabled = ["git-status", "make"]
retrieve_disable_threshold = 3Champs de filtre
| Champ | Type | Rôle |
|---|---|---|
| schema_version | int | File-level schema marker (recommended 1; reserved for future validation) |
| description | string | Human-readable note (not used at filter runtime) |
| version | string | Capability version for retrieve / telemetry (e.g. "1") |
| match_command | string | Command-path selector: regex against the full command line |
| match_output_select | string[] | Pipe-path selector: regexes against the complete piped output; use (?m) for line anchors |
| strip_ansi | bool | Remove terminal color codes first (before other stages) |
| replace | array | Line-level regex replacements: { pattern, replacement } |
| match_output | array | If output matches pattern, return message instead (optional unless) |
| strip_lines_matching | string[] | Drop lines matching any pattern |
| keep_lines_matching | string[] | Keep only matching lines |
| dedupe_lines_matching | string[] | Keep the first exact copy of each matching line; drop later identical copies |
| collapse_lines_matching | array | Replace matching lines with one summary: { pattern, template } — {count} = number of matches |
| head_lines / tail_lines | int | Keep first or last N lines |
| on_empty | string | Message when filtering removes everything |
Mettez schema_version = 1 en tête de chaque fichier. Étapes : strip ANSI → replace → match_output → strip/keep → dedupe → collapse → head/tail → on_empty. Référence complète dans docs/TOML_FILTERS.md.