Løsning af Husky Pre-Commit Hook-problemer i Visual Studio 2022

Forstå problemet

Jeg støder på et problem med Husky pre-commit hooks i et lager, der indeholder både et C# .NET Core-projekt og en React-app. .git-mappen er placeret i rodmappen, mens React-app-projektet er i en undermappe (klient-app).

Jeg får følgende fejl, når jeg forsøger at forpligte mig i Git Changes-vinduet i Visual Studio 2022: Mærkeligt nok commiter det fint, hvis jeg er i VSCode eller bruger Git CMD Line i MS Terminal.

Detaljeret scriptforklaring

De medfølgende scripts er designet til at automatisere præ-commit-tjek for et lager, der indeholder både et C# .NET Core-projekt og en React-app. Node.js scriptet bruger execSync fra child_process modul til at køre shell-kommandoer synkront. Dette er afgørende for at udføre kommandoer som f.eks npm run lint og npm test indenfor client-app vejviser. Manuskriptet gør også brug af fs.readFileSync for at læse commit-meddelelsen, hvilket sikrer, at commit-processen kan stoppes, hvis pre-commit-kontrollen mislykkes. Stimodulets path.resolve bruges til at bestemme de korrekte mappestier, hvilket gør scriptet tilpasset til forskellige miljøer.

I shell-scriptet er cd "$(dirname "$0")/../.." kommandoen ændrer den aktuelle mappe til projektets rod. Dette efterfølges af navigering til client-app mappe og kører npm run lint og npm test. Hvis en af ​​disse kommandoer mislykkes, afsluttes scriptet med en fejlkode vha exit 1. Integrationen af ​​disse scripts med Husky sikrer, at kontrol af kodekvalitet konsekvent håndhæves, før der foretages commits, hvilket forhindrer problemer i at blive introduceret i kodebasen.

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"
  ]
}

Udforskning af yderligere løsninger

Et aspekt, der ikke er blevet behandlet, er den potentielle påvirkning af Node.js-miljøet på Husky-hooks. Forskellige versioner af Node.js kan nogle gange forårsage kompatibilitetsproblemer med forskellige npm-pakker, inklusive Husky. At sikre, at Node.js-versionen, der bruges i Visual Studio 2022, matcher den, der bruges i VSCode og Git CMD-linjen, kan løse uoverensstemmelserne. Brug af et værktøj som nvm (Node Version Manager) giver udviklere mulighed for nemt at skifte mellem forskellige versioner af Node.js.

Derudover kan konfiguration af Husky til at give mere detaljeret logning hjælpe med at finde ud af, hvor problemet ligger. Ved at tilføje detaljerede logningsmuligheder i Husky-konfigurationen kan udviklere få indsigt i de specifikke trin og kommandoer, der mislykkes. Denne information kan være afgørende for at identificere forskelle i, hvordan Visual Studio 2022 håndterer pre-commit hooks sammenlignet med VSCode og Git CMD Line.

Afslutning af løsningen

Den leverede løsning udnytter Node.js-scripts og shell-kommandoer til at løse problemet med Husky pre-commit hooks, der fejler i Visual Studio 2022. Ved at sikre den korrekte Node.js version, detaljeret logning og korrekt konfiguration af Husky kan udviklere opretholde ensartet kode kvalitetstjek. Artiklen dækker forskellige fejlfindingstrin og understreger vigtigheden af ​​at bruge kompatible npm-pakkeversioner. Implementering af disse løsninger kan hjælpe med at forhindre begå fejl og sikre en mere smidig udviklingsproces.