24
novembre
2022
15:11

Vérification orthographique par lots des fichiers Markdown à l'aide du correcteur orthographique gratuit cSpell

24 novembre 2022 15:11

J'ai récemment reçu une lettre avec un commentaire dans laquelle un visiteur du site a noté un grand nombre de fautes de frappe dans les articles.
Comment automatiser le processus de vérification orthographique – cet article traite de cela.

Présentation

Pour corriger les erreurs, vous devez d'abord les trouver. Il existe des programmes de vérification orthographique pour cela.
L'un de ces programmes est l'utilitaire de ligne de commande gratuit mais puissant cSpell.

Qu'est-ce que cSpell

cSpell est ce qu'on appelle un « correcteur orthographique » (papier calque du mot anglais « correcteur orthographique »), un programme permettant de vérifier l'orthographe (orthographe correcte des mots) et d'identifier les fautes de frappe dans le texte.

Site Web du programme :https://cspell.org/, page GitHub :https://github.com/streetsidesoftware/cspell.

Contrairement à d'autres programmes, il fonctionne à partir de la ligne de commande et vous permet de vérifier les répertoires de manière récursive, et prend également en charge plusieurs langues simultanément (pour les textes multilingues). De plus, le programme cSpell connaît les mots-clés des langages de programmation tels que JavaScript, TypeScript, Python, PHP, C.#, C++, LaTex, Go, HTML, CSS. La vitesse de vérification du texte est élevée : la vérification d'un fichier de 4 Ko sur un processeur Core2Duo 2 GHz prend 4 secondes.

Installation de Snap

Vous devez d’abord installer un programme alternatif de gestion de packages casser(voir Description de l'installation instantanée sur itfoss.com).

Depuis que j'ai Linux Mint, qui est proche d'Ubuntu, j'ai installé Snap à l'aide des commandes APT :

sudo apt update
sudo apt install snapd

Installation de NodeJS et NPM

Pour exécuter cSpell, vous devez d'abord installer Node JS - une version côté serveur très puissante de JavaScript pour écrire et exécuter des programmes. Site Web Node JS affichant la dernière version :https://github.com/nodejs/release.
Il existe plusieurs façons d'installer Node JS, j'ai choisi l'option d'installation de casser.

Remarque : si vous avez déjà installé une ancienne version de nodejs, désinstallez d'abord node :
sudo snap remove node

1) Installez le programme de gestion des packages Node JS et NPM

nœud d'installation sudo snap --classic --channel=19

!!!Pour 2025, la version actuelle est la 22.14.0. La commande d'installation ci-dessous l'installera.

sudo snap install node --classic --channel=22

L'environnement d'exécution Node JS et le programme de gestion de packages NPM seront installés. Vérification des versions du programme :

version npm

2) Vider le cache NPM

npm cache clean --force

3) Ensuite j'ai supprimé les traces de l'installation précédente du module "n" qui se trouvaient dans le système d'exploitation :

sudo rm -R /usr/lib/node_modules/n

4) Installé le programme "n" globalement :

sudo npm install -g n

5) Mise à jour du runtime avec "n" nœud js:

sudo n stable

6) Installation de l'utilitaire npm-check-updates (également connu sous le nom de ncu)

sudo npm install -g npm-check-updates

7) Lancement d'une mise à jour du système, y compris la mise à jour du gestionnaire de packages npm :

sudo npm mise à jour -g

8) Créez un fichier "package.json" personnalisé pour votre projet local

cd ~
PATH="$PATH" 
npm init

Nous répondons à toutes les questions de l’assistant en appuyant sur Entrée.

Installation du programme cSpell

L'installation du correcteur orthographique cSpell se fait avec une seule commande :

sudo npm install -g cspell

Installation et connexion d'un dictionnaire de langue russe à cSpell

Par défaut, cSpell ne connaît que l'anglais. Pour lui « apprendre » le russe, vous devez installer et connecter un dictionnaire de langue russe (source -https://www.npmjs.com/package/@cspell/dict-ru_ru) :

Installation d'un dictionnaire de langue russe dans CSpell :

sudo npm install -g @cspell/dict-ru_ru

Ajoutez un lien vers le dictionnaire :

lien cspell ajouter @cspell/dict-ru_ru

Définition de la langue du document à l'aide du fichier de configuration cspell.json

Dans le dossier à partir duquel cSpell sera lancé (généralement le dossier personnel de l'utilisateur), créez un fichier texte portant le nom cspell.json(une liste détaillée des dossiers dans lesquels le programme recherche le fichier de configuration est répertoriée dans article sur CSpell.org).

cd ~
nano cspell.json

Collez le contenu suivant au format json et enregistrez les modifications (Ctrl+O, Ctrl+X) :

// cSpell Settings

{

"version": "0.2",
    "language": "en,ru",
    "words": [
        "vcfm",
        "webp",
        "Yaesu",
        "распиновка"
    ]
}

Mise à jour des dictionnaires cSpell depuis Internet

sudo npm update -g

ncu -g

[====================] 6/6 100%

All global packages are up-to-date :)

Test de CSpell

echo "этороверка работы eckho test" > test.txt
npx cspell test.txt

CSpell imprimera les mots mal orthographiés.

Exemples de vérification orthographique des fichiers *.md (format Markdown)

1) Utiliser cSpell pour vérifier l'orthographe des fichiers Markdown dans le répertoire "test"

npx cspell test/*.md

---/test/item.md:29:119 - Unknown word (доставелен)
---/test/item.md:49:45 - Unknown word (микровыключатель)
---/test/item.md:64:26 - Unknown word (разъм)
---/test/item.md:78:1 - Unknown word (Цифроые)

Où 29 est le numéro de ligne, 119 est la position du mot erroné dans la ligne.

2) Vérification orthographique par lots des fichiers *.md dans les sous-répertoires du dossier "blog", en écrivant les résultats de la vérification dans un fichier errata.txt:

npx cspell blog/**/*.md > errata.txt

Quelle est la prochaine étape ?

Vous devez corriger les erreurs de syntaxe et les fautes de frappe trouvées dans chacun des fichiers vérifiés dans un éditeur de texte.
Vous pouvez également explorer les fonctionnalités supplémentaires du programme sur la page d'accueil sur GitHub, ainsi que la commande "lint", qui est utilisée pour vérifier les fichiers non seulement au format markdown, mais également dans d'autres, par exemple *.txt :

npx cspell lint --help

Source :Article « Vérification orthographique de vos articles de blog markdown avec cspell »


Dernier changement - 14/04/2025