lds-check

Beschreibung

Die Methode "Lesen durch Schreiben" ist eine Methode des Schriftspracherwerbs, bei der Schülerinnen und Schüler das Schreiben durch das Lesen von bereits geschriebenen Wörtern und Sätzen erlernen sollen. Dabei wird "nach Gehör" geschrieben, d.h. die Schülerinnen und Schüler schreiben die Wörter und Sätze ohne die korrekte Schreibweise zu kennen. Die Schülerinnen und Schüler sollen dabei die Schreibweise der Wörter und Sätze durch das Lesen der Wörter und Sätze erlernen.

Diese Bibliothek stellt eine Funktion checkLetter zur Verfügung, welche überprüft, ob - gegeben einen (korrekt geschriebenen) Wortes - der nächste Buchstabe entsprechend der Methode zulässig ist.

Regeln

Zulässig sind Eingaben, die folgende Regeln beachten:

• Entspricht dem korrektem Buchstaben/der richtigen Rechtschreibung
• Groß-/Kleinschreibung wird ignoriert
• Lautähnliche Buchstaben werden gleich behandelt ("p" und "b", "d" und "t", "c" und "k", "v" und "f", "z" zu "s", "y" zu "u" oder "i", "u" zu "o")
• Doppelbuchstaben können ignoriert werden
• Stummes "h" kann ignoriert werden (allerdings nicht am Anfang eines Wortes)
• "e" in "ie" kann ignoriert werden
• "c" in "ck" kann ignoriert werden
• "pf" zu Beginn kann durch "f" ersetz werden

Anwendung

Die Funktion checkLetter kann wie folgt verwendet werden:

const { checkLetter } = require('lds-check')
console.log(checkLetter('Vogel', 1, 'f')) // überprüft ob der Buchstabe "f" an der Stelle 1 im Wort "Vogel" zulässig ist -> true

Entwicklung

Softwareinstallation

Folgende Software muss auf dem Entwicklungsrechner installiert werden:

• Editor: Visual Studio Code ("VS Code"): https://code.visualstudio.com/Download - Windows, User Installer, x64
• Versionskontrolle - Git: https://git-scm.com/download/win - Windows, 64-Bit Git for Windows Setup. Bei der Installation "git bash" auswählen.
• Node.js: https://nodejs.org/en/download/ - Windows Installer, 64-Bit

VS Code

Einrichtung

Sprache auf Deutsch umstellen:

Falls VS code auf Englisch startet, kann die Sprache auf Deutsch umgestellt werden:

1. "File" -> "Preferences" -> "Settings" auswählen
2. "Locale" in der Suche eingeben
3. "Locale" auswählen
4. "de" eingeben
5. "Reload Required" bestätigen

Git bash als Standard Shell einstellen:

1. "File" -> "Preferences" -> "Settings" auswählen
2. "terminal integrated windows" in der Suche eingeben
3. "Terminal > Integrated > Default Profile: Windows" auswählen
4. "Git Bash" auswählen

Erweiterungen

Für die Entwicklung werden keine Erweiterungen benötigt. Die folgenden Erweiterungen können aber hilfreich sein:

• Prettier - Automatische Code-Formattierung
• Gitmoji - Emojis in Commit-Nachrichten
• Git Graph - übersichtliche Darstellung des Repositories
• Wallaby.js - automatische Testausführung (30d Testversion)

Die Installation der Erweiterungen erfolgt über die "Extensions" Ansicht. Diese wird über "Strg + Shift + X" geöffnet - oder über das "Vierecksymbol" in der Seitenleiste. Danach kann die Erweiterung gesucht und installiert werden.

Bedienung

Alle Kommandos können über die "Command Palette" ausgeführt werden. Diese wird über "Strg + Shift + P" geöffnet. Danach kann der Befehl eingegeben werden. Dateien können über die "Explorer" Ansicht geöffnet werden - oder direkt über "Strg + P" und dem Dateinamen.

Git-Repository klonen

Der Quellcode des Projekts wird über das Versionskontrollsystem Git verwaltet - in einem "Repository". Dieses wird auf GitHub gehostet. Das Versionskontrollsystem ermöglicht es, den Quellcode auf mehreren Entwicklungsrechnern zu bearbeiten und die Änderungen zu synchronisieren.

Um das Projekt lokal zu verwenden:

1. GitHub Konto anlegen: https://www.github.com
2. GitHub Administrator (Peter) Nutzer Zugriff auf das Projekt gewähren
3. Git Repository klonen: a. VS Code starten b. "Clone Repository" auswählen c. URL des Repositories eingeben: https://github.com/d2i-dd/projektwoche23 d. Zielverzeichnis auswählen e. "Clone" auswählen

Projekt initialisieren

• Terminal öffnen: "Terminal" -> "New Integrated Terminal" (oder "Strg + ö")
• Installation von "pnpm" Paket Manager: npm i -g pnpm
• Installation der Abhängigkeiten: pnpm i

Tests starten

• Terminal öffnen: "Terminal" -> "New Integrated Terminal" (oder "Strg + ö")
• Tests starten: pnpm test
• Um Tests während der Entwicklung automatisch auszuführen: pnpm test:watch