Atom pour des shell scripts : Différence entre versions

De Ensiwiki
Aller à : navigation, rechercher
(La base)
(Utilisation de shellcheck)
Ligne 6 : Ligne 6 :
  
 
== Utilisation de shellcheck ==
 
== Utilisation de shellcheck ==
 +
 +
[http://www.shellcheck.net/ shellcheck] est un outil d'analyse de code shell, qui trouve un bon nombre de bugs classiques dans des script shell. Il a deux intérêts : 1) il donne des messages d'erreur pertinent et vous permettra sans doute de gagner du temps par rapport au "syntax error" que votre shell est capable de vous donner, et 2) il trouve automatiquement beaucoup de bugs (qui vous auraient coûté des points sur un TP noté ...). À l'Ensimag, shellcheck est installé. Sur vos machines personnelles, vous pouvez l'installer si ce n'est pas déjà fait.
 +
 +
Tout comme l'outil pylint avec Python, shellcheck peut s'intégrer dans Atom : il suffit d'installer le package [https://atom.io/packages/linter-shellcheck linter-shellcheck]. Au choix : en ligne de commande via <code>apm install linter-shellcheck</code>, ou depuis l'interface graphique d'Atom (Edit -> Preferences -> "+ Install").
 +
 +
Par défaut, linter-shellcheck n'affiche pas tous les messages (en particulier, il ne dit rien quand on écrit <code>echo $i</code>, [[Erreurs_fr%C3%A9quentes_dans_les_scripts_shell#guillemets|qui est pourtant presque certainement une erreur]]). Pour avoir tous les messages : Menu Edit -> Préférences -> Packages -> linter-shellcheck -> Settings => cocher la case "Enable notice messages".
 +
 +
Une fois ceci fait, vous aurez la correction en cours de frappe dans Atom.

Version du 14 novembre 2016 à 14:52

Cette page recense quelques astuces pour bien utiliser l'éditeur de texte Atom pour écrire des script shell. Si vous ne l'avez pas encore lu, la page Premiers pas avec Atom et Python peut vous aider à démarrer avec Atom.

La base

Atom reconnaît les script shell automatiquement si le fichier script a un nom terminant par .sh, ou si le shell-bang est présent en début de fichier (#! /bin/sh). Si vous respectez l'une (ou les deux) de ces conventions, tout se passera bien : coloration syntaxique, indentation automatique, complétion, ...

Utilisation de shellcheck

shellcheck est un outil d'analyse de code shell, qui trouve un bon nombre de bugs classiques dans des script shell. Il a deux intérêts : 1) il donne des messages d'erreur pertinent et vous permettra sans doute de gagner du temps par rapport au "syntax error" que votre shell est capable de vous donner, et 2) il trouve automatiquement beaucoup de bugs (qui vous auraient coûté des points sur un TP noté ...). À l'Ensimag, shellcheck est installé. Sur vos machines personnelles, vous pouvez l'installer si ce n'est pas déjà fait.

Tout comme l'outil pylint avec Python, shellcheck peut s'intégrer dans Atom : il suffit d'installer le package linter-shellcheck. Au choix : en ligne de commande via apm install linter-shellcheck, ou depuis l'interface graphique d'Atom (Edit -> Preferences -> "+ Install").

Par défaut, linter-shellcheck n'affiche pas tous les messages (en particulier, il ne dit rien quand on écrit echo $i, qui est pourtant presque certainement une erreur). Pour avoir tous les messages : Menu Edit -> Préférences -> Packages -> linter-shellcheck -> Settings => cocher la case "Enable notice messages".

Une fois ceci fait, vous aurez la correction en cours de frappe dans Atom.