YAML et Emacs
Ce tutoriel s'adresse aux utilisateurs et utilisatrices de GNU Emacs et ses dérivés.
YAML est un format de représentation de données, il est plus élaboré que du JSON mais moins que du XML. YAML n'est pas géré de base au moins jusqu'à la version 24.4 de GNU Emacs. Mais il existe yaml-mode qui est un mode pour les fichiers YAML.
Installer yaml-mode
Installation via le Web ou git
Il est possible de le télécharger depuis
le dépôt GitHub yoshiki/yaml-mode.
Ensuite, il faut placer le yaml-mode.el
dans un dossier faisant parti de load-path
(généralement ajouté avec
(add-to-list 'load-path "~/.emacs.d/packages/")
).
Il est également possible de l'installer proprement sur le système via le makefile,
mais si vous choississez cette option vous devrez peut être adapter le makefile,
de plus il est fortement recommendé de ne pas utiliser cette possibilité
si vous ne connaissez pas la commande make.
Ensuite, il faut configurer Emacs, en modifiant votre fichier de configuration ".emacs" en Emacs Lisp. Il se trouve normalement dans votre dossier personnel, qui sous un système UNIX-like (comme une distribution GNU/Linux ou un *BSD) est facilement accessible avec "~/.emacs" ou "$HOME/.emacs".
Il faut ajouter (require 'yaml-mode)
à votre fichier de configuration.
Vous pouvez recharger votre fichier de configuration avec
M-x load-file RET chemin-vers-fichier-de-configuration
(avec RET étant la touche Entrée)
(cela évite de redémarrer Emacs).
Installation via un gestionnaire de sources de paquets
Si votre système vous fournit un système de gestion de paquets ou que vous en avez installer un, vous pourrez peut être installé yaml-mode via un paquet. Voici une liste non exhaustive des noms du paquet correspondant pour différents systèmes :
- Debian : yaml-mode
- Trisquel : yaml-mode
- Ubuntu : yaml-mode
- ArchLinux (AUR) : emacs-yaml-mode
- NetBSD : wip/yaml-mode
- MacPorts : yaml-mode.el
Sous Debian, Trisquel et Ubuntu, vous pouvez installer le paquet avec un shell texte
(avec apt-get install yaml-mode
ou aptitude install yaml-mode
ou apt install yaml-mode
)
ou via une interface graphique
(comme Synaptic).
Utiliser yaml-mode
-
Pour activer le mode dans un buffer
où l'extension n'est pas reconnu,
il faut utiliser
M-x yaml-mode
(avec M correspondant à la touche Mêta, généralement Alt). -
Pour que yaml-mode soit activé pour les fichiers finissant par ".yml",
il faut ajouter
(add-to-list 'auto-mode-alist '("\\.yml$" . yaml-mode))
à votre fichier de configuration ".emacs".