Husky Pre-Commit Hook -ongelmien ratkaiseminen Visual Studio 2022:ssa

Ongelman ymmärtäminen

Kohtasin ongelman Huskyn ennakkositoumuskoukkujen kanssa arkistossa, joka sisältää sekä C# .NET Core -projektin että React-sovelluksen. .git-hakemisto sijaitsee juurihakemistossa, kun taas React-sovellusprojekti on alihakemistossa (asiakassovellus).

Saan seuraavan virheen, kun yritän sitoutua Visual Studio 2022:n Git Changes -ikkunassa: Kummallista kyllä, se sitoutuu hyvin, jos olen VSCodessa tai käytän Git CMD Linea MS Terminalissa.

Yksityiskohtainen komentosarjan selitys

Toimitetut komentosarjat on suunniteltu automatisoimaan toimitusta edeltävät tarkistukset arkistolle, joka sisältää sekä C# .NET Core -projektin että React-sovelluksen. Node.js-skripti käyttää execSync alkaen child_process moduuli suorittaa komentotulkkikomentoja synkronisesti. Tämä on tärkeää suoritettaessa komentoja, kuten npm run lint ja npm test sisällä client-app hakemistosta. Käsikirjoitus hyödyntää myös fs.readFileSync lukemaan toimitussanoman ja varmistamaan, että toimitusprosessi voidaan pysäyttää, jos toimitusta edeltävät tarkistukset epäonnistuvat. Polkumoduuli path.resolve käytetään määrittämään oikeat hakemistopolut, jolloin skripti voidaan mukauttaa erilaisiin ympäristöihin.

Shell-skriptissä cd "$(dirname "$0")/../.." komento muuttaa nykyisen hakemiston projektin juureksi. Tätä seuraa navigointi kohteeseen client-app hakemisto ja käynnissä npm run lint ja npm test. Jos jompikumpi näistä komennoista epäonnistuu, komentosarja poistuu virhekoodilla käyttämällä exit 1. Näiden komentosarjojen integrointi Huskyn kanssa varmistaa, että koodin laaduntarkistuksia valvotaan johdonmukaisesti ennen sitoumuksia, mikä estää ongelmien joutumisen koodikantaan.

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

Lisäratkaisujen tutkiminen

Yksi näkökohta, jota ei ole käsitelty, on Node.js-ympäristön mahdollinen vaikutus Husky-koukkuihin. Node.js:n eri versiot voivat joskus aiheuttaa yhteensopivuusongelmia eri npm-pakettien, mukaan lukien Huskyn, kanssa. Epäjohdonmukaisuudet voidaan ratkaista varmistamalla, että Visual Studio 2022:ssa käytetty Node.js-versio vastaa VSCodessa ja Git CMD Line -versiossa käytettyä versiota. Käyttämällä työkalua, kuten nvm (Node Version Manager) antaa kehittäjille mahdollisuuden vaihtaa Node.js:n eri versioiden välillä helposti.

Lisäksi Huskyn määrittäminen tarjoamaan yksityiskohtaisempia lokitietoja voi auttaa paikantamaan ongelman. Lisäämällä monisanaisia ​​kirjausvaihtoehtoja Husky-kokoonpanoon kehittäjät voivat saada tietoa yksittäisistä vaiheista ja komennoista, jotka epäonnistuvat. Nämä tiedot voivat olla ratkaisevia tunnistamaan eroja siinä, miten Visual Studio 2022 käsittelee pre-commit-koukut VSCodeen ja Git CMD Lineen verrattuna.

Ratkaisun päättäminen

Toimitettu ratkaisu hyödyntää Node.js-skriptejä ja komentotulkkikomentoja ratkaistakseen ongelman, jonka mukaan Huskyn pre-commit-koukut epäonnistuvat Visual Studio 2022:ssa. Varmistamalla oikean Node.js-version, yksityiskohtaisen kirjauksen ja Huskyn oikean konfiguroinnin kehittäjät voivat ylläpitää johdonmukaista koodia laatutarkastukset. Artikkeli kattaa useita vianetsintävaiheita ja korostaa yhteensopivien npm-pakettiversioiden käytön tärkeyttä. Näiden ratkaisujen käyttöönotto voi auttaa estämään virheitä ja varmistamaan sujuvamman kehitysprosessin.