Harmonise les fichiers MarkDown et y ajoute des insécables

[bboulesteix]

Cette pull-request est purement cosmétique :

• elle passe les fichiers MarkDown dans un linter pour standardiser leur mise en forme (j’utilise linter-markdown sous Atom) ;
• elle ajoute des espaces insécables devant certains caractères ( ?,  ;,  :) pour éviter les signes de ponctuation orphelins en début de ligne.

[bboulesteix]

Est-ce qu'on peut documenter l'usage du linter quelque part ? Genre sur la page Typographie de etalab/etalab ?

Pourquoi pas, oui, bonne idée. 👍 Même si, en gros, le linter ne fait qu’appliquer un styleguide MarkDown — en l’occurrence, celui de prettier.

Pour que le linter soit vraiment utile, il ne devrait à mon avis passer sur nos textes qu’en bout de chaîne, à la toute fin, au moment du build, à la manière de Travis par exemple. De cette manière, nous aurions des fichiers cohérents à l’arrivée. C’est ce que permet de faire une application comme : https://github.com/apps/unibeautify-ci.

Nous pourrions aussi aller plus loin, et considérer qu’il est important d’avoir des fichiers source, c’est-à-dire des fichiers de travail (MarkDown) cohérents aussi. Ce qui impliquerait que nous utilisions tous le même linter dans nos éditeurs de texte respectifs.

Au total, nous avons donc le choix :

1. Ou bien nous adoptons tous le même linter dans nos éditeurs de texte (prettier donc) ;
2. Ou bien nous mettons en place une application comme unibeautify-ci en bout de chaîne ;
3. Ou bien nous faisons les deux (linter dans l’éditeur et au moment du build) pour se blinder.

Si ces propositions te semblent raisonnables, @abulte, y en a-t-il une qui a ta préférence ?

[abulte]

@bboulesteix La 3 me parait pas mal. Les profils techniques seront contents de produire du Markdown cohérent dès le début (et vérifier les éventuelles pétouilles) et les "autres" ne s'embêteront pas avec ça et produiront du Markdown cohérent sans même le savoir. En revanche il faut que le linter dans l'éditeur et dans la CI fasse exactement la même chose, sinon ça sera l'enfer.

S'il ne faut choisir qu'une seule option entre 1 et 2, ce serait 1 pour moi.

[bboulesteix]

Merci pour ta réponse @abulte.

En revanche il faut que le linter dans l'éditeur et dans la CI fasse exactement la même chose, sinon ça sera l'enfer.

Tout à fait d’accord. La bonne nouvelle, c’est que c’est possible. 🎉 Car unibeautify-ci utilise prettier en guise de styleguide pour sa moulinette MarkDown.

Nous pouvons donc avoir :

• du prettier dans notre éditeur de texte, avec atom-beautify par exemple (ce dernier n’utilise pas prettier par défaut, mais le propose en option dans la configuration du package) ;
• du prettier en bout de chaîne, avec unibeautify-ci.

Prettier all the thingz. 🚀

[bboulesteix]

Pour l’installation de https://github.com/apps/unibeautify-ci, j’ai créé #61, @abulte. Ce qui me permet de fermer cette pull request. Encore merci pour ton aide et tes conseils. 👏