Beheben von Husky-Pre-Commit-Hook-Problemen in Visual Studio 2022

Das Problem verstehen

Ich stoße auf ein Problem mit Husky-Pre-Commit-Hooks in einem Repository, das sowohl ein C# .NET Core-Projekt als auch eine React-App enthält. Das .git-Verzeichnis befindet sich im Stammverzeichnis, während sich das React-App-Projekt in einem Unterverzeichnis (client-app) befindet.

Ich erhalte die folgende Fehlermeldung, wenn ich versuche, im Git-Änderungsfenster in Visual Studio 2022 einen Commit durchzuführen: Seltsamerweise funktioniert der Commit einwandfrei, wenn ich mich in VSCode befinde oder Git CMD Line in MS Terminal verwende.

Detaillierte Skripterklärung

Die bereitgestellten Skripte dienen der Automatisierung von Pre-Commit-Prüfungen für ein Repository, das sowohl ein C# .NET Core-Projekt als auch eine React-App enthält. Das Node.js-Skript verwendet execSync von dem child_process Modul zum synchronen Ausführen von Shell-Befehlen. Dies ist entscheidend für die Ausführung von Befehlen wie npm run lint Und npm test innerhalb der client-app Verzeichnis. Das Skript nutzt auch fs.readFileSync um die Commit-Nachricht zu lesen und sicherzustellen, dass der Commit-Prozess angehalten werden kann, wenn die Prüfungen vor dem Commit fehlschlagen. Die Pfadmodule path.resolve wird verwendet, um die richtigen Verzeichnispfade zu ermitteln, wodurch das Skript an verschiedene Umgebungen angepasst werden kann.

Im Shell-Skript wird die cd "$(dirname "$0")/../.." Der Befehl ändert das aktuelle Verzeichnis in das Stammverzeichnis des Projekts. Anschließend erfolgt die Navigation zum client-app Verzeichnis und läuft npm run lint Und npm test. Wenn einer dieser Befehle fehlschlägt, wird das Skript mit einem Fehlercode beendet exit 1. Durch die Integration dieser Skripte in Husky wird sichergestellt, dass vor der Durchführung von Commits konsequent Codequalitätsprüfungen durchgeführt werden, wodurch verhindert wird, dass Probleme in die Codebasis eingeführt werden.

const { execSync } = require('child_process');
const fs = require('fs');
const path = require('path');

const rootDir = path.resolve(__dirname, '..', '..');
const clientAppDir = path.resolve(rootDir, 'client-app');
const gitDir = path.resolve(rootDir, '.git');

if (!fs.existsSync(gitDir)) {
    console.error('Git directory not found');
    process.exit(1);
}

const commitMsg = fs.readFileSync(path.resolve(gitDir, 'COMMIT_EDITMSG'), 'utf-8');
if (!commitMsg) {
    console.error('No commit message found');
    process.exit(1);
}

try {
    execSync('npm run lint', { cwd: clientAppDir, stdio: 'inherit' });
    execSync('npm test', { cwd: clientAppDir, stdio: 'inherit' });
} catch (error) {
    console.error('Pre-commit checks failed');
    process.exit(1);
}

console.log('Pre-commit checks passed');
process.exit(0);

#!/bin/sh
# Navigate to the root directory
cd "$(dirname "$0")/../.."

# Set the path to the client app
client_app_path="./client-app"

# Run lint and tests in the client app directory
cd "$client_app_path" || exit 1

echo "Running lint checks..."
npm run lint || exit 1

echo "Running tests..."
npm test || exit 1

echo "Pre-commit checks passed!"
exit 0

"husky": {
  "hooks": {
    "pre-commit": "npm run precommit"
  }
}

"scripts": {
  "precommit": "lint-staged"
}

"lint-staged": {
  "*.js": [
    "npm run lint",
    "npm test"
  ]
}

Erkundung zusätzlicher Lösungen

Ein Aspekt, der nicht angesprochen wurde, ist der mögliche Einfluss der Node.js-Umgebung auf Husky-Hooks. Verschiedene Versionen von Node.js können manchmal Kompatibilitätsprobleme mit verschiedenen npm-Paketen, einschließlich Husky, verursachen. Durch Sicherstellen, dass die in Visual Studio 2022 verwendete Node.js-Version mit der in VSCode und der Git CMD-Zeile verwendeten Version übereinstimmt, könnten die Inkonsistenzen behoben werden. Mit einem Werkzeug wie nvm (Node Version Manager) ermöglicht Entwicklern den einfachen Wechsel zwischen verschiedenen Versionen von Node.js.

Darüber hinaus kann die Konfiguration von Husky für eine detailliertere Protokollierung dabei helfen, die Ursache des Problems zu ermitteln. Durch das Hinzufügen ausführlicher Protokollierungsoptionen in der Husky-Konfiguration können Entwickler Einblicke in die spezifischen Schritte und Befehle gewinnen, die fehlschlagen. Diese Informationen können entscheidend sein, um Unterschiede in der Handhabung von Pre-Commit-Hooks durch Visual Studio 2022 im Vergleich zu VSCode und Git CMD Line zu identifizieren.

Zusammenfassung der Lösung

Die bereitgestellte Lösung nutzt Node.js-Skripte und Shell-Befehle, um das Problem zu beheben, dass Husky-Pre-Commit-Hooks in Visual Studio 2022 fehlschlagen. Durch Sicherstellen der richtigen Node.js-Version, detaillierter Protokollierung und ordnungsgemäßer Konfiguration von Husky können Entwickler konsistenten Code beibehalten Qualitätskontrollen. Der Artikel behandelt verschiedene Schritte zur Fehlerbehebung und betont die Wichtigkeit der Verwendung kompatibler npm-Paketversionen. Die Implementierung dieser Lösungen kann dazu beitragen, Commit-Fehler zu vermeiden und einen reibungsloseren Entwicklungsprozess sicherzustellen.