Ajoute une validation JSDoc

[thom4parisot]

Ça nous permettra d'être plus rigoureux sur la documentation des fonctions. Y'a 64 erreurs avec la documentation existante :-) (les corrections viennent de eslint --fix).

Un chouette article : https://schof.co/writing-jsdoc-for-react-components/

[netlify]

✅ Deploy Preview for stylo-docs canceled.

Name	Link
🔨 Latest commit	f53bb42
🔍 Latest deploy log	https://app.netlify.com/sites/stylo-docs/deploys/67939043d6744900081904b2

[netlify]

✅ Deploy Preview for stylo-dev ready!

Name	Link
🔨 Latest commit	f53bb42
🔍 Latest deploy log	https://app.netlify.com/sites/stylo-dev/deploys/67939043e3b66c00088a0172
😎 Deploy Preview	https://deploy-preview-1194--stylo-dev.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[ggrossetie]

Trop bien 👌🏻
Est ce qu'il y a des outils qui valident la documentation avec l'utilisation ? (i.e., j'utilise un type qui est incorrect par rapport à la jsdoc)

[thom4parisot]

Hm, ce que tu demandes c'est la validation typescript… dans le code ? Sinon j'ai pas compris.

[ggrossetie]

Oui mais sans utiliser TypeScript 😄

[thom4parisot]

J'ai ajouté un commit qui tente une vérification typescript. Bon, je ne suis pas vraiment sûr si ça doit être eslint qui vérifie ça ou si c'est ok d'ajouter le module typescript (il n'a pas l'air aware de certains trucs liés à vite).

[ggrossetie]

J'ai ajouté un commit qui tente une vérification typescript. Bon, je ne suis pas vraiment sûr si ça doit être eslint qui vérifie ça ou si c'est ok d'ajouter le module typescript (il n'a pas l'air aware de certains trucs liés à vite).

C'était plus par curiosité, autant avancer par étape, le plugin eslint est déjà une très bonne première étape. Quand on aura plus de jsdoc en place ça vaudra surement le coup d'aller plus loin dans la validation.

Je pense qu'on peut fusionner avec ton premier commit 👍🏻

[thom4parisot]

Oui carrément. J'ai enlevé le dernier commit.