Řešení problémů s Husky Pre-Commit Hook ve Visual Studiu 2022

Pochopení problému

Narážím na problém s Husky pre-commit hooks v úložišti, které obsahuje projekt C# .NET Core i aplikaci React. Adresář .git se nachází v kořenovém adresáři, zatímco projekt aplikace React je v podadresáři (client-app).

Při pokusu o potvrzení v okně Git Changes v aplikaci Visual Studio 2022 se mi zobrazuje následující chyba: Kupodivu se to potvrdí v pořádku, pokud jsem ve VSCode nebo používám Git CMD Line v MS Terminal.

Podrobné vysvětlení skriptu

Poskytnuté skripty jsou navrženy tak, aby automatizovaly kontroly před potvrzením pro úložiště obsahující projekt C# .NET Core i aplikaci React. Skript Node.js využívá execSync z child_process modul pro synchronní spouštění příkazů shellu. To je zásadní pro provádění příkazů, jako je npm run lint a npm test v rámci client-app adresář. Skript také využívá fs.readFileSync pro přečtení zprávy odevzdání, což zajistí, že proces odevzdání může být zastaven, pokud selžou kontroly před potvrzením. Modul cesty path.resolve se používá k určení správných cest k adresářům, díky čemuž je skript přizpůsobitelný různým prostředím.

Ve skriptu shellu je cd "$(dirname "$0")/../.." příkaz změní aktuální adresář na kořenový adresář projektu. Následuje navigace do client-app adresář a běží npm run lint a npm test. Pokud některý z těchto příkazů selže, skript se ukončí s použitím chybového kódu exit 1. Integrace těchto skriptů s Husky zajišťuje, že kontroly kvality kódu jsou důsledně vynucovány před provedením jakýchkoli potvrzení, což zabraňuje vnesení problémů do kódové základny.

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

Zkoumání dalších řešení

Jedním aspektem, který nebyl řešen, je potenciální dopad prostředí Node.js na háky Husky. Různé verze Node.js mohou někdy způsobit problémy s kompatibilitou s různými balíčky npm, včetně Husky. Zajištěním, že verze Node.js používaná ve Visual Studiu 2022 odpovídá verzi použité ve VSCode a Git CMD Line, by mohlo nekonzistence vyřešit. Pomocí nástroje jako nvm (Node Version Manager) umožňuje vývojářům snadno přepínat mezi různými verzemi Node.js.

Navíc konfigurace Husky tak, aby poskytovala podrobnější protokolování, může pomoci určit, kde je problém. Přidáním možností podrobného protokolování do konfigurace Husky mohou vývojáři získat přehled o konkrétních krocích a příkazech, které selžou. Tyto informace mohou být klíčové při identifikaci rozdílů ve způsobu, jakým Visual Studio 2022 zpracovává háky před potvrzením ve srovnání s VSCode a Git CMD Line.

Zabalení řešení

Poskytované řešení využívá skripty Node.js a příkazy shellu k vyřešení problému selhávání háčků Husky pre-commit ve Visual Studiu 2022. Zajištěním správné verze Node.js, podrobného protokolování a správné konfigurace Husky mohou vývojáři udržovat konzistentní kód kontroly kvality. Článek se zabývá různými kroky odstraňování problémů a zdůrazňuje důležitost používání kompatibilních verzí balíčků npm. Implementace těchto řešení může pomoci předcházet chybám a zajistit hladší proces vývoje.