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

Forstå problemet

Jeg støter på et problem med Husky pre-commit hooks i et depot som inneholder både et C# .NET Core-prosjekt og en React-app. .git-katalogen ligger i rotkatalogen, mens React-appprosjektet er i en underkatalog (klient-app).

Jeg får følgende feilmelding når jeg prøver å forplikte meg i Git Changes-vinduet i Visual Studio 2022: Merkelig nok, det forplikter meg fint hvis jeg er i VSCode eller bruker Git CMD Line i MS Terminal.

Detaljert skriptforklaring

Skriptene som tilbys er designet for å automatisere forhåndskontroller for et depot som inneholder både et C# .NET Core-prosjekt og en React-app. Node.js-skriptet bruker execSync fra child_process modul for å kjøre skallkommandoer synkront. Dette er avgjørende for å utføre kommandoer som npm run lint og npm test innen client-app katalog. Manuset gjør også bruk av fs.readFileSync for å lese commit-meldingen, og sikre at commit-prosessen kan stoppes hvis pre-commit-kontrollene mislykkes. Banemodulens path.resolve brukes til å bestemme de riktige katalogbanene, slik at skriptet kan tilpasses forskjellige miljøer.

I shell-skriptet er det cd "$(dirname "$0")/../.." kommandoen endrer gjeldende katalog til prosjektets rot. Dette etterfølges av navigering til client-app katalog og kjører npm run lint og npm test. Hvis en av disse kommandoene mislykkes, avsluttes skriptet med en feilkode ved hjelp av exit 1. Integreringen av disse skriptene med Husky sikrer at kvalitetskontroller av kode blir konsekvent håndhevet før noen forpliktelser foretas, og forhindrer at problemer introduseres 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"
  ]
}

Utforsker flere løsninger

Et aspekt som ikke har blitt behandlet, er den potensielle innvirkningen av Node.js-miljøet på Husky-hooks. Ulike versjoner av Node.js kan noen ganger forårsake kompatibilitetsproblemer med forskjellige npm-pakker, inkludert Husky. Å sikre at Node.js-versjonen som brukes i Visual Studio 2022 samsvarer med den som brukes i VSCode og Git CMD-linjen, kan løse inkonsekvensene. Ved å bruke et verktøy som nvm (Node Version Manager) lar utviklere enkelt bytte mellom ulike versjoner av Node.js.

I tillegg kan konfigurere Husky for å gi mer detaljert logging hjelpe til med å finne ut hvor problemet ligger. Ved å legge til detaljerte loggingsalternativer i Husky-konfigurasjonen, kan utviklere få innsikt i de spesifikke trinnene og kommandoene som mislykkes. Denne informasjonen kan være avgjørende for å identifisere forskjeller i hvordan Visual Studio 2022 håndterer pre-commit hooks sammenlignet med VSCode og Git CMD Line.

Avslutter løsningen

Den medfølgende løsningen utnytter Node.js-skript og shell-kommandoer for å løse problemet med Husky pre-commit hooks som svikter i Visual Studio 2022. Ved å sikre riktig Node.js-versjon, detaljert logging og riktig konfigurasjon av Husky, kan utviklere opprettholde konsistent kode kvalitetskontroller. Artikkelen dekker ulike feilsøkingstrinn og understreker viktigheten av å bruke kompatible npm-pakkeversjoner. Implementering av disse løsningene kan bidra til å forhindre begå feil og sikre en jevnere utviklingsprosess.