Risoluzione dei problemi di hook pre-commit di Husky in Visual Studio 2022

Comprendere il problema

Sto riscontrando un problema con gli hook di pre-commit Husky in un repository che contiene sia un progetto C# .NET Core che un'app React. La directory .git si trova nella directory root, mentre il progetto dell'app React si trova in una sottodirectory (app-client).

Ricevo il seguente errore quando provo a eseguire il commit nella finestra Git Changes in Visual Studio 2022: Stranamente, il commit funziona correttamente se sono in VSCode o utilizzo la riga Git CMD in MS Terminal.

Spiegazione dettagliata dello script

Gli script forniti sono progettati per automatizzare i controlli pre-commit per un repository contenente sia un progetto C# .NET Core che un'app React. Lo script Node.js utilizza execSync dal child_process modulo per eseguire i comandi della shell in modo sincrono. Questo è fondamentale per eseguire comandi come npm run lint E npm test all'interno del client-app directory. Lo script fa uso anche di fs.readFileSync per leggere il messaggio di commit, assicurando che il processo di commit possa essere interrotto se i controlli di pre-commit falliscono. Il modulo del percorso path.resolve viene utilizzato per determinare i percorsi corretti delle directory, rendendo lo script adattabile a diversi ambienti.

Nello script della shell, il file cd "$(dirname "$0")/../.." Il comando cambia la directory corrente nella radice del progetto. Successivamente si accede al file client-app directory e in esecuzione npm run lint E npm test. Se uno di questi comandi fallisce, lo script termina con un codice di errore utilizzando exit 1. L'integrazione di questi script con Husky garantisce che i controlli di qualità del codice vengano applicati in modo coerente prima che venga effettuato qualsiasi commit, impedendo l'introduzione di problemi nel codice base.

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

Esplorare soluzioni aggiuntive

Un aspetto che non è stato affrontato è il potenziale impatto dell'ambiente Node.js sugli hook Husky. Versioni diverse di Node.js a volte possono causare problemi di compatibilità con vari pacchetti npm, incluso Husky. Garantire che la versione di Node.js utilizzata in Visual Studio 2022 corrisponda a quella utilizzata in VSCode e nella riga Git CMD potrebbe risolvere le incoerenze. Utilizzando uno strumento come nvm (Node Version Manager) consente agli sviluppatori di passare facilmente tra diverse versioni di Node.js.

Inoltre, la configurazione di Husky per fornire una registrazione più dettagliata può aiutare a individuare dove si trova il problema. Aggiungendo opzioni di registrazione dettagliate nella configurazione di Husky, gli sviluppatori possono ottenere informazioni dettagliate sui passaggi e sui comandi specifici che non riescono. Queste informazioni possono essere cruciali per identificare le differenze nel modo in cui Visual Studio 2022 gestisce gli hook di pre-commit rispetto a VSCode e Git CMD Line.

Conclusione della soluzione

La soluzione fornita sfrutta gli script Node.js e i comandi shell per risolvere il problema degli hook pre-commit Husky non riusciti in Visual Studio 2022. Garantendo la versione corretta di Node.js, la registrazione dettagliata e la corretta configurazione di Husky, gli sviluppatori possono mantenere il codice coerente controlli di qualità. L'articolo copre vari passaggi per la risoluzione dei problemi e sottolinea l'importanza dell'utilizzo di versioni del pacchetto npm compatibili. L'implementazione di queste soluzioni può aiutare a prevenire errori di commit e garantire un processo di sviluppo più fluido.