Husky előzetes bekötési horogproblémák megoldása a Visual Studio 2022-ben

A probléma megértése

Problémával találkoztam a Husky előzetes elfogadási hookkal egy olyan adattárban, amely egy C# .NET Core projektet és egy React alkalmazást is tartalmaz. A .git könyvtár a gyökérkönyvtárban, míg a React alkalmazásprojekt egy alkönyvtárban (kliens-alkalmazás) található.

A következő hibaüzenetet kapom, amikor a Visual Studio 2022 Git Changes ablakában próbálom meg a véglegesítést: Furcsa módon ez jól végrehajt, ha VSCode-ban vagyok, vagy Git CMD Line-t használok az MS Terminalban.

Részletes script magyarázat

A biztosított szkriptek a C# .NET Core projektet és a React alkalmazást egyaránt tartalmazó adattárak véglegesítés előtti ellenőrzéseinek automatizálására szolgálnak. A Node.js szkript használja execSync tól child_process modul a shell parancsok szinkron futtatásához. Ez kulcsfontosságú az olyan parancsok végrehajtásához, mint pl npm run lint és npm test belül client-app Könyvtár. A forgatókönyv is felhasználja fs.readFileSync a véglegesítési üzenet elolvasásához, biztosítva, hogy a véglegesítési folyamat leállítható legyen, ha a véglegesítés előtti ellenőrzések sikertelenek. Az útvonal modulé path.resolve a megfelelő könyvtárútvonalak meghatározására szolgál, így a szkript adaptálhatóvá válik a különböző környezetekhez.

A shell szkriptben a cd "$(dirname "$0")/../.." parancs megváltoztatja az aktuális könyvtárat a projekt gyökérkönyvtárára. Ezt követi a navigáció a client-app könyvtár és futás npm run lint és npm test. Ha a parancsok bármelyike ​​sikertelen, a szkript a következő hibakóddal lép ki exit 1. Ezeknek a szkripteknek a Husky-val való integrációja biztosítja, hogy a kódminőség-ellenőrzések következetesen érvényesüljenek a véglegesítés előtt, megakadályozva ezzel a problémák kódbázisba való bekerülését.

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

További megoldások felfedezése

Az egyik szempont, amellyel még nem foglalkoztak, a Node.js környezetnek a Husky hookra gyakorolt ​​lehetséges hatása. A Node.js különböző verziói néha kompatibilitási problémákat okozhatnak különböző npm-csomagokkal, köztük a Husky-val. Ha gondoskodik arról, hogy a Visual Studio 2022-ben használt Node.js-verzió megegyezzen a VSCode-ban és a Git CMD-vonalban használt verzióval, az megoldhatja a következetlenségeket. Olyan eszköz használatával, mint pl nvm (Node Version Manager) segítségével a fejlesztők könnyedén válthatnak a Node.js különböző verziói között.

Ezenkívül a Husky részletesebb naplózásra konfigurálása segíthet meghatározni a probléma helyét. Ha részletes naplózási beállításokat ad hozzá a Husky konfigurációhoz, a fejlesztők betekintést nyerhetnek a hibás lépésekbe és parancsokba. Ez az információ kulcsfontosságú lehet a Visual Studio 2022 által a VSCode-hoz és a Git CMD Line-hoz képest a véglegesítés előtti horgok kezelésében mutatkozó különbségek azonosításában.

A megoldás lezárása

A mellékelt megoldás Node.js szkripteket és shell-parancsokat használ a Visual Studio 2022 programban a Husky előzetes véglegesítési hookok meghibásodásának problémájára. A megfelelő Node.js verzió, a részletes naplózás és a Husky megfelelő konfigurációjának biztosításával a fejlesztők konzisztens kódot tarthatnak fenn. minőségi ellenőrzések. A cikk különféle hibaelhárítási lépéseket ismertet, és hangsúlyozza a kompatibilis npm csomagverziók használatának fontosságát. Ezeknek a megoldásoknak a megvalósítása segíthet megelőzni az elkövetési hibákat, és gördülékenyebb fejlesztési folyamatot biztosít.