24
November
2022
15:11

Batch-Rechtschreibprüfung von Markdown-Dateien mit der kostenlosen Rechtschreibprüfung cSpell

24 November 2022 15:11

Kürzlich erhielt ich einen Brief mit einem Kommentar, in dem ein Seitenbesucher eine große Anzahl von Tippfehlern in Artikeln bemerkte.
So automatisieren Sie die Rechtschreibprüfung – darüber geht es in diesem Artikel.

Einführung

Um Fehler zu beheben, müssen Sie diese zunächst finden. Dafür gibt es Programme zur Rechtschreibprüfung.
Ein solches Programm ist das kostenlose, aber leistungsstarke Befehlszeilendienstprogramm cSpell.

Was ist cSpell?

cSpell ist ein sogenannter „Spell Checker“ (Pauspapier vom englischen Wort „spell checker“), ein Programm zur Überprüfung der Rechtschreibung (korrekte Schreibweise von Wörtern) und zum Erkennen von Tippfehlern im Text.

Programm-Website:https://cspell.org/, GitHub-Seite:https://github.com/streetsidesoftware/cspell.

Im Gegensatz zu anderen Programmen funktioniert es über die Befehlszeile und ermöglicht die rekursive Überprüfung von Verzeichnissen sowie die gleichzeitige Unterstützung mehrerer Sprachen (für mehrsprachige Texte). Außerdem kennt das cSpell-Programm die Schlüsselwörter von Programmiersprachen wie JavaScript, TypeScript, Python, PHP, C#, C++, LaTex, Go, HTML, CSS. Die Geschwindigkeit der Textprüfung ist hoch – die Prüfung einer 4-kB-Datei auf einem Core2Duo-2-GHz-Prozessor dauert 4 Sekunden.

Snap installieren

Zuerst müssen Sie ein alternatives Paketverwaltungsprogramm installieren Schnapp(siehe Beschreibung der Snap-Installation auf itfoss.com).

Da ich Linux Mint habe, das Ubuntu ähnelt, habe ich Snap mit APT-Befehlen installiert:

sudo apt update
sudo apt install snapd

NodeJS und NPM installieren

Um cSpell auszuführen, müssen Sie zunächst Node JS installieren – eine serverseitige, sehr leistungsfähige Version von JavaScript zum Schreiben und Ausführen von Programmen. Node JS-Website mit der neuesten Version:https://github.com/nodejs/release.
Es gibt mehrere Möglichkeiten, Node JS zu installieren. Ich habe die Installationsoption ausgewählt Schnapp.

Hinweis: wenn Sie zuvor eine ältere Version von NodeJS installiert haben, deinstallieren Sie zuerst Node:
sudo snap remove node

1) Installieren Sie das Paketverwaltungsprogramm Node JS und NPM

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

!!!Für 2025 ist die aktuelle Version 22.14.0. Mit dem folgenden Installationsbefehl wird es installiert.

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

Die Node JS-Laufzeitumgebung und das NPM-Paketmanagerprogramm werden installiert. Programmversionen prüfen:

npm-Version

2) Leeren Sie den NPM-Cache

npm cache clean --force

3) Dann habe ich Spuren der vorherigen Installation des Moduls „n“ entfernt, die im Betriebssystem waren:

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

4) Das Programm „n“ global installiert:

sudo npm install -g n

5) Die Laufzeit mit „n“ aktualisiert Knoten js:

sudo n stable

6) Installierte das Dienstprogramm npm-check-updates (auch bekannt als ncu)

sudo npm install -g npm-check-updates

7) Ein Systemupdate gestartet, einschließlich der Aktualisierung des npm-Paketmanagers:

sudo npm update -g

8) Erstellen Sie eine benutzerdefinierte „package.json“-Datei für Ihr lokales Projekt

cd ~
PATH="$PATH" 
npm init

Wir beantworten alle Fragen des Assistenten, indem wir die Eingabetaste drücken.

Installieren des cSpell-Programms

Die Installation der Rechtschreibprüfung cSpell erfolgt mit einem Befehl:

sudo npm install -g cspell

Installieren und Verbinden eines Russisch-Wörterbuchs mit cSpell

Standardmäßig beherrscht cSpell nur Englisch. Um ihm Russisch „beizubringen“, müssen Sie ein russisches Wörterbuch installieren und anschließen (Quelle -https://www.npmjs.com/package/@cspell/dict-ru_ru):

Installieren eines Russisch-Wörterbuchs in CSpell:

sudo npm install -g @cspell/dict-ru_ru

Fügen Sie einen Link zum Wörterbuch hinzu:

cspell-Link @cspell/dict-ru_ru hinzufügen

Festlegen der Dokumentsprache mithilfe der Konfigurationsdatei cspell.json

Erstellen Sie in dem Ordner, aus dem cSpell gestartet wird (normalerweise der Home-Ordner des Benutzers), eine Textdatei mit dem Namen cspell.json(Eine detaillierte Liste der Ordner, in denen das Programm nach der Konfigurationsdatei sucht, finden Sie unter Artikel auf CSpell.org).

cd ~
nano cspell.json

Fügen Sie den folgenden Inhalt im JSON-Format ein und speichern Sie die Änderungen (Strg+O, Strg+X):

// cSpell Settings

{

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

Aktualisieren von cSpell-Wörterbüchern aus dem Internet

sudo npm update -g

ncu -g

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

All global packages are up-to-date :)

Testlauf von CSpell

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

CSpell druckt falsch geschriebene Wörter.

Beispiele für die Rechtschreibprüfung von *.md-Dateien (Markdown-Format)

1) Verwenden Sie cSpell, um die Rechtschreibung von Markdown-Dateien im Verzeichnis „test“ zu überprüfen

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 (Цифроые)

Dabei ist 29 die Zeilennummer und 119 die Position des fehlerhaften Wortes in der Zeile.

2) Batch-Rechtschreibprüfung von *.md-Dateien in Unterverzeichnissen im Ordner „blog“, wobei die Prüfergebnisse in eine Datei geschrieben werden errata.txt:

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

Was kommt als nächstes?

Sie müssen die in jeder der überprüften Dateien gefundenen Syntaxfehler und Tippfehler in einem Texteditor korrigieren.
Sie können auch zusätzliche Funktionen des Programms auf der Startseite erkunden auf GitHub, sowie der Befehl „lint“, mit dem Dateien nicht nur im Markdown-Format, sondern auch in anderen, zum Beispiel *.txt, überprüft werden:

npx cspell lint --help

Quelle:Artikel „Rechtschreibprüfung Ihrer Markdown-Blogbeiträge mit cspell“


Letzte Änderung – 14.04.2025