Menyelesaikan Isu Cangkuk Pra-Komit Husky dalam Visual Studio 2022

Memahami Isu

Saya menghadapi masalah dengan cangkuk prakomit Husky dalam repositori yang mengandungi kedua-dua projek Teras C# .NET dan apl React. Direktori .git terletak dalam direktori akar, manakala projek aplikasi React berada dalam subdirektori (apl pelanggan).

Saya mendapat ralat berikut apabila saya cuba membuat komitmen dalam tetingkap Git Changes dalam Visual Studio 2022: Anehnya, ia berfungsi dengan baik jika saya berada dalam VSCode atau menggunakan Git CMD Line dalam MS Terminal.

Penjelasan Skrip Terperinci

Skrip yang disediakan direka bentuk untuk mengautomasikan semakan prakomit untuk repositori yang mengandungi kedua-dua projek Teras C# .NET dan apl React. Skrip Node.js menggunakan execSync daripada child_process modul untuk menjalankan arahan shell secara serentak. Ini penting untuk melaksanakan arahan seperti npm run lint dan npm test Di antara client-app direktori. Skrip juga menggunakan fs.readFileSync untuk membaca mesej komit, memastikan proses komit boleh dihentikan jika semakan prakomit gagal. Modul laluan itu path.resolve digunakan untuk menentukan laluan direktori yang betul, menjadikan skrip boleh disesuaikan dengan persekitaran yang berbeza.

Dalam skrip shell, the cd "$(dirname "$0")/../.." arahan menukar direktori semasa kepada akar projek. Ini diikuti dengan menavigasi ke client-app direktori dan berjalan npm run lint dan npm test. Jika salah satu daripada arahan ini gagal, skrip akan keluar dengan kod ralat menggunakan exit 1. Penyepaduan skrip ini dengan Husky memastikan semakan kualiti kod dikuatkuasakan secara konsisten sebelum sebarang komitmen dibuat, menghalang isu daripada diperkenalkan ke dalam pangkalan kod.

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

Meneroka Penyelesaian Tambahan

Satu aspek yang belum ditangani ialah potensi kesan persekitaran Node.js pada cangkuk Husky. Versi Node.js yang berbeza kadangkala boleh menyebabkan masalah keserasian dengan pelbagai pakej npm, termasuk Husky. Memastikan versi Node.js yang digunakan dalam Visual Studio 2022 sepadan dengan versi yang digunakan dalam VSCode dan Git CMD Line boleh menyelesaikan ketidakkonsistenan. Menggunakan alat seperti nvm (Pengurus Versi Node) membenarkan pembangun bertukar antara versi Node.js yang berbeza dengan mudah.

Selain itu, mengkonfigurasi Husky untuk menyediakan pengelogan yang lebih terperinci boleh membantu menentukan di mana isu itu terletak. Dengan menambahkan pilihan pengelogan bertele-tele dalam konfigurasi Husky, pembangun boleh mendapatkan cerapan tentang langkah dan arahan khusus yang gagal. Maklumat ini boleh menjadi penting dalam mengenal pasti perbezaan dalam cara Visual Studio 2022 mengendalikan cangkuk prakomit berbanding VSCode dan Git CMD Line.

Menggulung Penyelesaian

Penyelesaian yang disediakan memanfaatkan skrip Node.js dan arahan shell untuk menangani isu cangkuk prakomit Husky yang gagal dalam Visual Studio 2022. Dengan memastikan versi Node.js yang betul, pengelogan terperinci dan konfigurasi Husky yang betul, pembangun boleh mengekalkan kod yang konsisten pemeriksaan kualiti. Artikel itu merangkumi pelbagai langkah penyelesaian masalah dan menekankan kepentingan menggunakan versi pakej npm yang serasi. Melaksanakan penyelesaian ini boleh membantu mencegah kesilapan dan memastikan proses pembangunan yang lebih lancar.