Ajouter une fonction de vérification orthographique à votre projet NodeJS


Hacktoberfest, un hackathon virtuel qui a lieu au mois d’octobre, est une excellente occasion d’ajouter quelque chose de nouveau à un projet open source. Ma première demande de pull Hacktoberfest était de Twilio SendGrid’s référentiel de documents, ajout d’une fonction de vérification orthographique.

Cette fonctionnalité est si importante pour les projets à grande échelle où plusieurs personnes contribuent au démarquage et aux pages HTML, et il peut être difficile de garder une trace de tous les changements. Même à une échelle personnelle, cette fonctionnalité est idéale pour des projets tels que la rédaction de cet article de blog. L’ajout d’une fonction de vérification orthographique est super facile pour les utilisateurs débutants de NPM, alors continuez à lire pour voir comment vous pouvez l’ajouter à votre prochain projet.

Installer

Si vous modifiez un projet NodeJS existant, passez au paragraphe suivant. Même si vous n’êtes pas familier avec NodeJS ou NPM, cela ne devrait pas être trop difficile. NodeJS est incroyable dès la sortie de la boîte. Je ne vais pas expliquer comment configurer NodeJS et NPM, mais vous pouvez apprendre à le faire ici.

Si vous partez d’un tout nouveau répertoire, initialisez le dossier en tant que projet NodeJS typique via la ligne de commande.

S’il démarre correctement, vous devriez être prêt à passer à la section suivante.

Correcteur orthographique

Pour la fonctionnalité de vérification orthographique, j’utilise le package npm appelé vérification orthographique. Ce package est génial car il peut gérer de nombreuses erreurs, vérifier l’orthographe de nombreux fichiers / répertoires et ne modifie en fait aucun code. Au lieu de cela, le package affiche son analyse sur stdout.

La fonctionnalité de fin permettra à la commande npm run spellcheck pour vérifier l’orthographe de tous les fichiers HTML et démarques et autoriser la npm run spellcheck-file [filename] vérifier l’orthographe [filename] (étant donné qu’il s’agit de HTML ou de démarque).

Tout d’abord, nous devons initialiser le package en l’ajoutant en tant que dépendance à package.json. Tout cela peut être fait sur la ligne de commande par le la magie de npm.

Exemple de sortie:

>> 16 fautes d’orthographe trouvées dans 1 fichier

Notez que mdspell ne renverra aucune erreur si vous n’avez aucun fichier ou erreur dans vos fichiers. Ensuite, nous devons modifier le package.json directement pour ajouter les scripts spellcheck et spellcheck-file.

Remarquez comment le `mdspell`la commande accepte les formats de répertoire avec des caractères génériques ‘*“Et peut exclure certains dossiers et sous-dossiers avec des points d’exclamation”!«.

Si vous souhaitez plus d’informations sur le mdspell commande ou markdown-spellcheck package npm, accédez à la vérification orthographique documentation du package.

Tester l’installation

Via la ligne de commande:

Devine quoi? Vous avez terminé! C’était aussi simple que ça.

Étape facultative

Votre correcteur orthographique revient-il avec un tas d’erreurs fausses positives à cause du jargon technologique? Si vous souhaitez ajouter des exceptions de dictionnaire personnalisées sans surcharge, vous pouvez implémenter le .spelling fichier qui est automatiquement vérifié par le mdspell commander. Après avoir fait .spelling fichier à la racine du projet, la syntaxe est assez simple.

Conclusion

Tl; dr: NodeJS est génial! Une fois que vous maîtrisez NodeJS, la partie la plus difficile est de trouver un package pour votre besoin. Cela ajoute une fonctionnalité utile de manière modulaire sans trop de travail. (Réinventer la roue pour ce problème pourrait facilement devenir énorme et complexe.)

Certains inconvénients potentiels de ce paquet que j’ai trouvé sont qu’il devient plus compliqué avec des outils CI comme Travis ou Jenkins à cause de tous les fichiers journaux générés. Cela peut être résolu en excluant la vérification de ces fichiers. Sinon, vous risquez mdspell gel et chronométrage de votre build. J’ai également remarqué que dictionnaire est médiocre, en particulier lors de l’analyse de contenu avec du jargon technique ou des fichiers de démarque avec du code. Cependant, la documentation du package inclut une option de dictionnaire personnalisé. Assurez-vous simplement de faire attention à ces détails!

Je recommanderais également fortement de participer à la prochaine Hacktoberfest. Contribuer à des projets open source est toujours un bon moyen de fléchir vos compétences. Et, en prime, vous pouvez obtenir du swag gratuit DigitalOcean à partir de seulement 4 demandes de tirage.

Close Menu