shellcheck-configuration

Présentation de la skill shellcheck-configuration

À quoi sert la skill shellcheck-configuration

La skill shellcheck-configuration aide un agent à mettre en place, interpréter et ajuster ShellCheck pour un vrai travail de qualité sur des scripts shell. Elle devient particulièrement utile quand vous avez besoin de plus que « lancer le linter » : configuration au niveau du projet, blocage en CI, choix du shell cible, stratégie de suppression des avertissements et conseils pour corriger les remontées sans casser la portabilité.

À qui s’adresse shellcheck-configuration

Cette skill convient bien :

• aux développeurs qui ajoutent ShellCheck à un dépôt pour la première fois
• aux équipes qui veulent standardiser le lint shell dans la CI ou lors de la revue de code
• aux mainteneurs qui assainissent des scripts bash, sh, dash ou ksh historiques
• aux reviewers qui veulent des règles de lint cohérentes plutôt que des commentaires au cas par cas

Si votre besoin principal est simplement « expliquer un code d’avertissement », un prompt classique peut suffire. Si vous avez besoin d’une configuration et d’une politique réutilisables, la shellcheck-configuration skill est un meilleur choix.

Le vrai besoin à couvrir

En général, les utilisateurs cherchent l’un de ces quatre résultats :

1. installer correctement ShellCheck sur leur plateforme
2. le configurer pour le bon shell et le bon niveau de tolérance aux règles
3. l’intégrer dans la CI ou dans les contrôles avant fusion
4. transformer une sortie de lint bruyante en correctifs exploitables et en standards de revue

Cette skill est particulièrement efficace quand votre objectif combine à la fois l’outillage et la prise de décision.

Ce qui distingue cette skill d’un prompt générique

Un prompt générique peut suggérer « d’utiliser ShellCheck ». La skill shellcheck-configuration est plus utile quand vous avez besoin d’un accompagnement structuré pour :

• choisir un shell cible et les options correspondantes
• décider quoi supprimer et quoi imposer
• créer une politique .shellcheckrc adaptée au dépôt
• gérer les faux positifs de manière maintenable
• utiliser ShellCheck pour la Code Review, et pas seulement pour des lints lancés en local

Contraintes importantes à connaître avant adoption

Cette skill est davantage centrée sur le conseil que sur l’automatisation. Les éléments visibles dans le dépôt montrent un unique SKILL.md, sans scripts d’aide ni ressources packagées : attendez-vous donc à de solides instructions et à des exemples, pas à des commandes clé en main adaptées à votre dépôt. Vous obtiendrez les meilleurs résultats si vous fournissez de vrais fichiers shell, les erreurs actuelles et le contexte de votre CI.

Comment utiliser la skill shellcheck-configuration

Contexte d’installation pour installer shellcheck-configuration

Installez la skill dans l’environnement de votre agent avec :

npx skills add https://github.com/wshobson/agents --skill shellcheck-configuration

Ensuite, assurez-vous que ShellCheck lui-même est disponible dans l’environnement où l’analyse sera exécutée :

# macOS
brew install shellcheck

# Ubuntu/Debian
apt-get install shellcheck

# Verify
shellcheck --version

La skill aide pour la configuration et l’usage ; elle ne remplace pas le binaire shellcheck.

Commencez par lire ce fichier

Commencez par :

• plugins/shell-scripting/skills/shellcheck-configuration/SKILL.md

Comme cette skill n’a ni README.md séparé, ni règles dédiées, ni scripts d’assistance, l’essentiel des conseils pratiques est concentré dans ce fichier. Lisez-le en premier avant de déduire les capacités de la skill à partir du dépôt plus large.

Cas d’usage où shellcheck-configuration est le plus pertinent

Utilisez shellcheck-configuration quand vous devez :

• créer ou affiner un .shellcheckrc de projet
• choisir entre une application stricte et une adoption progressive
• corriger des motifs d’avertissement récurrents dans de nombreux scripts
• intégrer ShellCheck dans des pipelines CI/CD
• relire une pull request contenant des modifications shell
• décider si un disable inline est acceptable

Les entrées nécessaires pour que la skill soit efficace

Fournissez des éléments concrets, pas seulement « configure ShellCheck ». Les meilleures entrées incluent :

• le shell cible : bash, sh, dash, ksh
• un script d’exemple ou un chemin de dépôt
• la sortie actuelle de shellcheck
• le fait que le code s’exécute en CI, dans des conteneurs ou sur plusieurs distributions
• la politique d’équipe : échec sur les warnings, seulement sur les erreurs, ou simple avis
• l’importance ou non de la portabilité vers POSIX sh

Sans ce contexte, la skill ne peut donner que des recommandations génériques.

Transformer un objectif flou en prompt solide

Prompt faible :

• « Aide-moi à utiliser ShellCheck. »

Prompt solide :

• « Use the shellcheck-configuration skill to propose a .shellcheckrc for a repo with mostly bash scripts, a few POSIX sh entrypoints, CI on Ubuntu, and a goal of blocking high-confidence issues while allowing justified inline suppressions. Explain each config choice and how it affects code review. »

Pourquoi cela fonctionne :

• le mix de shells est explicite
• le niveau d’exigence est défini
• les contraintes d’environnement sont données
• la demande porte sur la logique, pas seulement sur un fichier à générer

Exemple de prompt shellcheck-configuration pour la Code Review

Utilisez un prompt de ce type :

Use the shellcheck-configuration skill for Code Review. Review this shell script diff, identify the ShellCheck issues most likely to matter in production, separate correctness bugs from style issues, and recommend whether to fix, suppress, or ignore each one. Assume the repo standard is Bash in CI but portability matters for small utility scripts.

Cela donne de meilleurs résultats que « review this script », car vous demandez à l’agent de classer les problèmes et d’appliquer une politique.

Workflow conseillé, de l’installation à l’application stricte

1. Installez ShellCheck.
2. Appelez la skill shellcheck-configuration avec vos shells cibles et les objectifs du dépôt.
3. Générez ou affinez .shellcheckrc.
4. Exécutez d’abord shellcheck sur des scripts représentatifs.
5. Corrigez les avertissements les plus utiles avant d’imposer le lint en CI.
6. Définissez une politique de suppression pour les exceptions justifiées.
7. N’ajoutez l’intégration CI ou pre-commit qu’une fois le volume d’avertissements redevenu gérable.

Cette séquence réduit un mode d’échec fréquent : activer des barrières de lint avant que l’équipe ne se soit mise d’accord sur la politique.

Comment utiliser la skill avec une sortie de lint existante

Si vous avez déjà exécuté shellcheck, collez :

• les codes d’avertissement comme SC2086, SC2046, SC2155
• les lignes concernées
• le caractère intentionnel ou non du problème
• le shell déclaré par le shebang du script

La skill est particulièrement utile quand vous voulez savoir si un avertissement reflète :

• un vrai bug
• un risque de portabilité
• une préférence de style
• un faux positif qui mérite d’être supprimé

Les décisions de configuration les plus importantes

Les choix les plus structurants sont généralement :

• la justesse du shell cible
• l’usage ou non d’un .shellcheckrc au niveau du projet
• le moment où préférer des disable inline plutôt que des ignorances globales
• le fait que la CI échoue sur toutes les remontées ou seulement sur un sous-ensemble
• la part de code historique à laisser provisoirement hors du périmètre strict

Ces décisions influencent davantage la confiance dans l’outil que la correction d’un avertissement isolé.

Conseils pratiques pour améliorer la qualité des réponses

Demandez à la skill de produire :

• un brouillon de .shellcheckrc
• une politique de suppression avec exemples
• des exemples de commandes CI
• un triage des avertissements en « corriger maintenant » vs « plus tard »
• des consignes de revue de code pour les remontées récurrentes

C’est plus utile que de demander de la théorie brute sur ShellCheck. La skill contient les fondamentaux, mais sa vraie valeur est de les transformer en politique de dépôt.

FAQ sur la skill shellcheck-configuration

shellcheck-configuration convient-il aux débutants ?

Oui, si vous travaillez réellement sur des scripts shell. La skill inclut les bases de ShellCheck et des indications d’installation, donc elle peut aider un débutant à démarrer. Elle reste toutefois bien plus utile lorsqu’elle s’appuie sur de vrais scripts et de vrais avertissements.

Ai-je besoin de la skill shellcheck-configuration si je connais déjà ShellCheck ?

Peut-être. Si vous connaissez déjà le catalogue d’avertissements et les bases de la ligne de commande, la skill reste utile pour la configuration à l’échelle du dépôt, la politique CI, la stratégie de suppression et les workflows de revue pilotés par ShellCheck.

Inclut-elle des scripts d’automatisation ou des modèles CI prêts à l’emploi ?

Rien ne l’indique clairement dans cette skill. Les signaux du dépôt montrent seulement SKILL.md, donc il faut plutôt s’attendre à des conseils conceptuels et à des exemples qu’à des scripts fournis ou à des modèles réutilisables.

Dans quels cas ne pas utiliser shellcheck-configuration ?

Évitez-la si :

• vous avez seulement besoin d’exécuter shellcheck file.sh une fois
• votre problème n’a pas de rapport avec une politique d’analyse statique
• vous cherchez un auto-fixer ; ShellCheck signale surtout des problèmes, il ne réécrit pas principalement le code
• votre équipe a déjà arrêté sa configuration et n’a besoin que d’une référence de commandes

En quoi est-ce différent d’un prompt classique ?

Un prompt classique peut expliquer des avertissements, mais il passe souvent à côté des décisions au niveau du dépôt : shell cible, frontières de suppression, stratégie de déploiement progressif et standards de revue de code. Le shellcheck-configuration guide est plus adapté si vous cherchez une approche de lint reproductible, pas une réponse ponctuelle.

shellcheck-configuration est-il adapté aux dépôts avec plusieurs shells ?

Oui, mais seulement si vous indiquez explicitement le mix. Les dépôts qui contiennent à la fois des scripts bash et POSIX sh ont besoin d’un cadrage précis ; sinon, les recommandations risquent d’être trop optimisées pour un shell et de générer du bruit pour l’autre.

Comment améliorer la skill shellcheck-configuration

Donnez à la skill votre environnement shell réel

La façon la plus rapide d’améliorer les résultats de shellcheck-configuration consiste à préciser :

• le dialecte shell pour chaque groupe de scripts
• l’OS ou le runner CI
• si les scripts sont sourcés ou exécutés directement
• si la portabilité est requise

Les recommandations de ShellCheck dépendent fortement de la sémantique du shell. Des entrées ambiguës mènent à des conseils trop larges.

Fournissez de vrais fichiers, pas des résumés

Au lieu de dire « nous avons quelques scripts shell », donnez :

• un script représentatif
• le .shellcheckrc actuel, s’il existe
• quelques codes d’avertissement actuels
• des extraits CI qui exécutent déjà le lint

Cela permet à la skill de passer de bonnes pratiques génériques à une configuration concrète.

Demandez une politique, pas seulement de la syntaxe

Une demande plus solide serait :

• « draft a .shellcheckrc and explain what the team should enforce »

Une demande plus faible serait :

• « show shellcheck config options »

Les utilisateurs se soucient davantage de ce qu’il faut standardiser que de mémoriser des flags. Demandez à la skill de vous aider à choisir une politique maintenable.

Surveillez les modes d’échec fréquents

Voici des façons courantes d’obtenir une mauvaise réponse :

• ne pas préciser bash vs sh
• demander une politique zéro warning sur un dépôt historique très bruyant
• supprimer des avertissements globalement avant de les comprendre
• traiter toutes les remontées comme si elles avaient la même gravité
• ignorer le workflow de revue de code pour se concentrer uniquement sur les exécutions locales

La skill est la plus utile quand vous vous en servez pour prioriser, pas seulement pour lister.

Améliorer shellcheck-configuration pour les workflows de Code Review

Pour un usage en revue, demandez à la skill de classer les remontées en :

• correction fonctionnelle
• sécurité du quoting et des expansions
• portabilité
• maintenabilité
• style uniquement

Cela aide les reviewers à éviter de bloquer des fusions pour des sujets de style à faible valeur, tout en continuant à repérer les motifs shell dangereux.

Itérez après la première réponse

Après la première réponse, enchaînez avec :

• « tighten this config for CI »
• « make this safer for POSIX portability »
• « reduce false positives for sourced helper files »
• « which suppressions should stay inline rather than in .shellcheckrc? »

Le premier passage doit fixer une direction ; le second doit ajuster le niveau d’exigence.

Utilisez la skill pour déployer progressivement l’adoption

Pour de grands dépôts historiques, demandez :

1. une configuration de base en mode consultatif
2. une liste priorisée de corrections
3. une configuration cible plus stricte

Cette approche par étapes est souvent préférable à l’activation immédiate d’un lint bloquant, qui crée facilement une résistance large chez les développeurs.

Comparez les recommandations à la vraie sortie de ShellCheck

La meilleure boucle de validation est simple :

1. demandez à la skill une configuration et une politique
2. exécutez shellcheck
3. inspectez le mélange d’avertissements obtenu
4. réinjectez les résultats dans la skill pour affiner

Cette boucle transforme la shellcheck-configuration skill d’un guide statique en véritable outil de déploiement pratique.