Επίλυση προβλημάτων Husky Pre-Commit Hook στο Visual Studio 2022

Κατανόηση του Ζητήματος

Αντιμετωπίζω ένα πρόβλημα με τα hook pre-commit Husky σε ένα αποθετήριο που περιέχει ένα έργο C# .NET Core και μια εφαρμογή React. Ο κατάλογος .git βρίσκεται στον ριζικό κατάλογο, ενώ το έργο της εφαρμογής React βρίσκεται σε έναν υποκατάλογο (client-app).

Λαμβάνω το ακόλουθο σφάλμα όταν προσπαθώ να πραγματοποιήσω δέσμευση στο παράθυρο Αλλαγές Git στο Visual Studio 2022: Παραδόξως, εκτελείται μια χαρά εάν είμαι σε VSCode ή χρησιμοποιώ τη γραμμή Git CMD στο MS Terminal.

Λεπτομερής Επεξήγηση Σεναρίου

Τα σενάρια που παρέχονται έχουν σχεδιαστεί για να αυτοματοποιούν τους ελέγχους πριν από τη δέσμευση για ένα αποθετήριο που περιέχει ένα έργο C# .NET Core και μια εφαρμογή React. Το σενάριο Node.js χρησιμοποιεί execSync από το child_process μονάδα για να εκτελούνται εντολές φλοιού συγχρονισμένα. Αυτό είναι σημαντικό για την εκτέλεση εντολών όπως npm run lint και npm test μέσα στο client-app Ευρετήριο. Το σενάριο χρησιμοποιεί επίσης fs.readFileSync για να διαβάσετε το μήνυμα δέσμευσης, διασφαλίζοντας ότι η διαδικασία δέσμευσης μπορεί να σταματήσει εάν αποτύχουν οι έλεγχοι πριν από τη δέσμευση. Η ενότητα διαδρομής path.resolve χρησιμοποιείται για τον προσδιορισμό των σωστών διαδρομών καταλόγου, καθιστώντας το σενάριο προσαρμόσιμο σε διαφορετικά περιβάλλοντα.

Στο σενάριο του κελύφους, το cd "$(dirname "$0")/../.." εντολή αλλάζει τον τρέχοντα κατάλογο στη ρίζα του έργου. Ακολουθεί η πλοήγηση στο client-app κατάλογο και εκτέλεση npm run lint και npm test. Εάν κάποια από αυτές τις εντολές αποτύχει, το σενάριο εξέρχεται με έναν κωδικό σφάλματος χρησιμοποιώντας exit 1. Η ενσωμάτωση αυτών των σεναρίων με το Husky διασφαλίζει ότι οι έλεγχοι ποιότητας κώδικα επιβάλλονται με συνέπεια πριν γίνουν οποιεσδήποτε δεσμεύσεις, αποτρέποντας την εισαγωγή ζητημάτων στη βάση κώδικα.

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

Διερεύνηση πρόσθετων λύσεων

Μια πτυχή που δεν έχει αντιμετωπιστεί είναι η πιθανή επίδραση του περιβάλλοντος Node.js στα άγκιστρα Husky. Διαφορετικές εκδόσεις του Node.js μπορεί μερικές φορές να προκαλέσουν προβλήματα συμβατότητας με διάφορα πακέτα npm, συμπεριλαμβανομένου του Husky. Η διασφάλιση ότι η έκδοση Node.js που χρησιμοποιείται στο Visual Studio 2022 ταιριάζει με αυτήν που χρησιμοποιείται στο VSCode και η γραμμή Git CMD θα μπορούσε να επιλύσει τις ασυνέπειες. Χρησιμοποιώντας ένα εργαλείο όπως nvm (Node Version Manager) επιτρέπει στους προγραμματιστές να εναλλάσσονται μεταξύ διαφορετικών εκδόσεων του Node.js εύκολα.

Επιπλέον, η διαμόρφωση του Husky ώστε να παρέχει πιο λεπτομερή καταγραφή μπορεί να σας βοηθήσει να εντοπίσετε πού βρίσκεται το πρόβλημα. Προσθέτοντας αναλυτικές επιλογές καταγραφής στη διαμόρφωση του Husky, οι προγραμματιστές μπορούν να αποκτήσουν πληροφορίες για τα συγκεκριμένα βήματα και τις εντολές που αποτυγχάνουν. Αυτές οι πληροφορίες μπορεί να είναι κρίσιμες για τον εντοπισμό διαφορών στον τρόπο με τον οποίο το Visual Studio 2022 χειρίζεται τα hook προ-δέσμευσης σε σύγκριση με το VSCode και το Git CMD Line.

Τελειώνοντας τη Λύση

Η παρεχόμενη λύση αξιοποιεί τα σενάρια και τις εντολές φλοιού Node.js για την αντιμετώπιση του προβλήματος των αγκίστρων προ-δέσμευσης Husky που αποτυγχάνουν στο Visual Studio 2022. Διασφαλίζοντας τη σωστή έκδοση Node.js, τη λεπτομερή καταγραφή και τη σωστή διαμόρφωση του Husky, οι προγραμματιστές μπορούν να διατηρήσουν συνεπή κώδικα ποιοτικούς ελέγχους. Το άρθρο καλύπτει διάφορα βήματα αντιμετώπισης προβλημάτων και τονίζει τη σημασία της χρήσης συμβατών εκδόσεων πακέτων npm. Η εφαρμογή αυτών των λύσεων μπορεί να βοηθήσει στην αποφυγή σφαλμάτων και να εξασφαλίσει μια πιο ομαλή διαδικασία ανάπτυξης.