Rozwiązywanie problemów związanych z hakami Husky przed zatwierdzeniem w programie Visual Studio 2022

Zrozumienie problemu

Napotykam problem z hakami Husky przed zatwierdzeniem w repozytorium zawierającym zarówno projekt C# .NET Core, jak i aplikację React. Katalog .git znajduje się w katalogu głównym, natomiast projekt aplikacji React znajduje się w podkatalogu (aplikacja klienta).

Kiedy próbuję zatwierdzić w oknie Git Changes w Visual Studio 2022, pojawia się następujący błąd: Co dziwne, zatwierdza się poprawnie, jeśli korzystam z VSCode lub korzystam z linii Git CMD w terminalu MS.

Szczegółowe wyjaśnienie skryptu

Dostarczone skrypty mają na celu automatyzację kontroli przed zatwierdzeniem repozytorium zawierającego zarówno projekt C# .NET Core, jak i aplikację React. Skrypt Node.js wykorzystuje execSync z child_process moduł do synchronicznego uruchamiania poleceń powłoki. Ma to kluczowe znaczenie przy wykonywaniu poleceń takich jak npm run lint I npm test w ciągu client-app informator. Skrypt również wykorzystuje fs.readFileSync do odczytania komunikatu zatwierdzenia, zapewniając, że proces zatwierdzenia może zostać zatrzymany, jeśli kontrole przed zatwierdzeniem zawiodą. Moduł ścieżki path.resolve służy do określenia prawidłowych ścieżek katalogów, dzięki czemu skrypt można dostosować do różnych środowisk.

W skrypcie powłoki plik cd "$(dirname "$0")/../.." polecenie zmienia bieżący katalog na katalog główny projektu. Następnie następuje przejście do client-app katalog i działa npm run lint I npm test. Jeśli którekolwiek z tych poleceń nie powiedzie się, skrypt zakończy działanie z kodem błędu using exit 1. Integracja tych skryptów z Husky zapewnia, że ​​kontrole jakości kodu są konsekwentnie egzekwowane przed dokonaniem jakichkolwiek zatwierdzeń, zapobiegając wprowadzaniu problemów do bazy kodu.

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

Odkrywanie dodatkowych rozwiązań

Jednym z aspektów, który nie został poruszony, jest potencjalny wpływ środowiska Node.js na hooki Husky. Różne wersje Node.js mogą czasami powodować problemy ze zgodnością z różnymi pakietami npm, w tym Husky. Zapewnienie, że wersja Node.js używana w programie Visual Studio 2022 jest zgodna z wersją używaną w VSCode i wierszu Git CMD, może rozwiązać niespójności. Korzystanie z narzędzia takiego jak nvm (Node Version Manager) umożliwia programistom łatwe przełączanie pomiędzy różnymi wersjami Node.js.

Dodatkowo skonfigurowanie Husky tak, aby zapewniało bardziej szczegółowe rejestrowanie, może pomóc w określeniu, gdzie leży problem. Dodając szczegółowe opcje rejestrowania w konfiguracji Husky, programiści mogą uzyskać wgląd w konkretne kroki i polecenia, które zawiodły. Informacje te mogą mieć kluczowe znaczenie przy identyfikowaniu różnic w sposobie, w jaki Visual Studio 2022 obsługuje przechwyty przed zatwierdzeniem w porównaniu z VSCode i Git CMD Line.

Podsumowanie rozwiązania

Dostarczone rozwiązanie wykorzystuje skrypty Node.js i polecenia powłoki, aby rozwiązać problem z awarią haków przed zatwierdzeniem Husky w Visual Studio 2022. Zapewniając poprawną wersję Node.js, szczegółowe rejestrowanie i właściwą konfigurację Husky, programiści mogą zachować spójny kod kontrole jakości. W artykule omówiono różne kroki rozwiązywania problemów i podkreślono znaczenie używania zgodnych wersji pakietu npm. Wdrożenie tych rozwiązań może pomóc w zapobieganiu błędom popełniania i zapewnić płynniejszy proces programowania.