Menyelesaikan Masalah Kait Pra-Komit Husky di Visual Studio 2022

Memahami Masalahnya

Saya mengalami masalah dengan kait pra-komit Husky di repositori yang berisi proyek C# .NET Core dan aplikasi React. Direktori .git terletak di direktori root, sedangkan proyek aplikasi React berada di subdirektori (aplikasi klien).

Saya mendapatkan kesalahan berikut ketika saya mencoba melakukan di jendela Git Changes di Visual Studio 2022: Anehnya, ini dilakukan dengan baik jika saya menggunakan VSCode atau menggunakan Git CMD Line di MS Terminal.

Penjelasan Skrip Terperinci

Skrip yang disediakan dirancang untuk mengotomatiskan pemeriksaan pra-komitmen untuk repositori yang berisi proyek C# .NET Core dan aplikasi React. Skrip Node.js menggunakan execSync dari child_process modul untuk menjalankan perintah shell secara sinkron. Ini sangat penting untuk menjalankan perintah seperti npm run lint Dan npm test dalam client-app direktori. Script juga memanfaatkan fs.readFileSync untuk membaca pesan komit, memastikan bahwa proses komit dapat dihentikan jika pemeriksaan pra-komit gagal. Modul jalur path.resolve digunakan untuk menentukan jalur direktori yang benar, membuat skrip dapat beradaptasi dengan lingkungan yang berbeda.

Dalam skrip shell, file cd "$(dirname "$0")/../.." perintah mengubah direktori saat ini ke root proyek. Ini diikuti dengan menavigasi ke client-app direktori dan berjalan npm run lint Dan npm test. Jika salah satu dari perintah ini gagal, skrip keluar dengan menggunakan kode kesalahan exit 1. Integrasi skrip ini dengan Husky memastikan bahwa pemeriksaan kualitas kode diterapkan secara konsisten sebelum komitmen apa pun dilakukan, sehingga mencegah masuknya masalah ke dalam basis kode.

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

Menjelajahi Solusi Tambahan

Salah satu aspek yang belum diatasi adalah potensi dampak lingkungan Node.js pada Husky hooks. Versi Node.js yang berbeda terkadang dapat menyebabkan masalah kompatibilitas dengan berbagai paket npm, termasuk Husky. Memastikan bahwa versi Node.js yang digunakan di Visual Studio 2022 cocok dengan yang digunakan di VSCode dan Git CMD Line dapat mengatasi ketidakkonsistenan. Menggunakan alat seperti nvm (Node Version Manager) memungkinkan pengembang untuk beralih di antara versi Node.js yang berbeda dengan mudah.

Selain itu, mengonfigurasi Husky untuk memberikan pencatatan log yang lebih detail dapat membantu menentukan letak masalahnya. Dengan menambahkan opsi logging verbose dalam konfigurasi Husky, pengembang dapat memperoleh wawasan tentang langkah-langkah dan perintah spesifik yang gagal. Informasi ini sangat penting dalam mengidentifikasi perbedaan dalam cara Visual Studio 2022 menangani hook pra-komit dibandingkan dengan VSCode dan Git CMD Line.

Menyelesaikan Solusinya

Solusi yang diberikan memanfaatkan skrip Node.js dan perintah shell untuk mengatasi masalah kegagalan hook pra-komit Husky di Visual Studio 2022. Dengan memastikan versi Node.js yang benar, pencatatan log mendetail, dan konfigurasi Husky yang tepat, pengembang dapat mempertahankan kode yang konsisten pemeriksaan kualitas. Artikel ini mencakup berbagai langkah pemecahan masalah dan menekankan pentingnya menggunakan versi paket npm yang kompatibel. Menerapkan solusi ini dapat membantu mencegah kesalahan penerapan dan memastikan proses pengembangan lebih lancar.