`.git-blame-ignore-revs` untuk mengabaikan perubahan pemformatan pukal.

.git-blame-ignore-revs ialah ciri Git yang diperkenalkan dalam versi 2.23 yang membolehkan anda mengabaikan komitmen tertentu dalam hasil git blame. Ini amat berguna untuk komitmen pukal yang menukar sejumlah besar baris tanpa mengubah kefungsian sebenar kod, seperti mengubah format, menamakan semula atau menggunakan piawaian pengekodan merentas pangkalan kod. Dengan mengabaikan perubahan tidak berfungsi ini, git blame boleh menumpukan pada pengeditan bermakna yang menerangkan konteks dan alasan di sebalik kod.

Kenapa .git-blame-ignore-revs Perkara

Apabila anda menggunakan git blame pada fail, ia menunjukkan kepada anda komit yang terakhir menukar setiap baris fail, bersama dengan pengarang dan cap waktu. Ini berguna untuk menjejaki sebab baris tertentu telah ditukar. Walau bagaimanapun, jika komitmen besar yang membuat perubahan pemformatan semata-mata, seperti menggunakan lebih cantik, adalah sebahagian daripada sejarah, git blame mungkin menunjukkan komitmen itu untuk banyak baris. Ini menyukarkan untuk mencari sejarah perubahan fungsi sebenar.

Sebagai contoh, jika pasukan anda menggunakan alat seperti Prettier atau ESLint untuk memformat semula keseluruhan pangkalan kod, komit yang terhasil mungkin menyentuh beribu-ribu baris kod. Tanpa .git-blame-ignore-revs, git blame akan menunjukkan komitmen ini sebagai bertanggungjawab untuk setiap baris yang terjejas, yang boleh mengaburkan sejarah yang lebih bermakna di sebalik setiap baris.

Dengan menggunakan .git-blame-ignore-revs, anda boleh memberitahu git blame untuk melangkau komitmen ini dan fokus pada perubahan yang penting.

Cara Menggunakan .git-blame-ignore-revs

Untuk memahami cara menggunakan ciri ini, mari kita lihat contoh daripada repositori React.

Langkah 1: Kenal pasti Komit Pemformatan Pukal

Kod sumber React termasuk komit pukal di mana alatan seperti Prettier dijalankan merentasi keseluruhan projek. Berikut ialah dua komitmen sedemikian:

1. Komited: c998bb1 Mesej: [penyusun] Jalankan lebih cantik, betulkan snap Komit ini menggunakan pemformatan Prettier merentas pangkalan kod, mengubah banyak baris tanpa mengubah fungsi.

2. Komit: fd2b3e1

Mesej: Penyusun: Buka garpu konfigurasi yang lebih cantik

Komit ini mengandungi kemas kini lanjut pada konfigurasi Prettier, yang menjejaskan semua fail .ts dan .tsx dalam repositori.

Komit ini hanya berurusan dengan pemformatan dan tidak memberikan konteks yang bermakna apabila menyiasat sebab baris kod ditulis seperti yang berlaku.

Langkah 2: Cipta Fail .git-blame-ignore-revs

Untuk membuat git blame mengabaikan komitmen pemformatan pukal ini, kita boleh mencipta fail .git-blame-ignore-revs dalam akar repositori.

1. Buat fail .git-blame-ignore-revs:

touch .git-blame-ignore-revs

2. Tambahkan cincang komit yang berkaitan pada fail, menerangkan sebab setiap komit diabaikan. Dalam kes ini, kami akan menambah dua komitmen yang kami kenal pasti sebelum ini:

# Prettier formatting changes 
c998bb1ed4b3285398c9c7797135d3f060243c6a 
fd2b3e13d330a4559f5aa21462e1cb2cbbcf144b

3. Simpan fail .git-blame-ignore-revs dalam repositori. Fail ini boleh diversikan bersama kod anda, membenarkan seluruh pasukan menggunakan senarai komit yang diabaikan yang sama.

Langkah 3: Konfigurasikan Git untuk Digunakan .git-blame-ignore-revs

Untuk mengelak daripada menaip pilihan --ignore-revs-file setiap kali anda menggunakan git blame, anda boleh mengkonfigurasi Git untuk menggunakan fail .git-blame-ignore-revs secara automatik.

1. Sediakan konfigurasi pada tahap repositori:

git config blame.ignoreRevsFile .git-blame-ignore-revs

Ini memastikan bahawa setiap kali seseorang menjalankan git blame dalam repositori ini, Git akan secara automatik mengabaikan komit yang disenaraikan dalam .git-blame-ignore-revs.

Langkah 4: Jalankan git blame dengan Ignored Commit

Mari lihat cara ini berfungsi dalam amalan. Tanpa mengabaikan komitmen pemformatan pukal, git blame mungkin menunjukkan:

$ git blame src/someFile.tsx
c998bb1e (Joe Bloggs 2023-03-15 10:00:00 +0200 1) import React from 'react';
fd2b3e13 (Alan 2023-04-01 14:15:30 +0200 2) function App() {
c998bb1e (Joe Bloggs 2023-03-15 10:00:00 +0200 3)     return <div>Hello, world!</div>;
fd2b3e13 (Ben 2023-04-01 14:15:30 +0200 4) }

Output ini menunjukkan bahawa perubahan terakhir kepada baris 1 dan 3 adalah disebabkan oleh komit pemformatan Prettier (c998bb1e), dan baris 2 dan 4 telah diubah suai dalam komit pukal lain (fd2b3e13). Memandangkan ini adalah perubahan pemformatan, ini tidak berguna untuk memahami siapa yang memperkenalkan logik sebenar di sebalik baris ini.

Selepas mengkonfigurasi .git-blame-ignore-revs, menjalankan git blame akan melangkau komit pukal dan menunjukkan sejarah sebenar:

$ git blame src/someFile.tsx
a23d9b34 (May 2022-12-01 09:30:00 +0200 1) import React from 'react';
b12e45a6 (JJ 2022-12-05 11:45:15 +0200 2) function App() {
a23d9b34 (Joe 2022-12-01 09:30:00 +0200 3)     return <div>Hello, world!</div>;
b12e45a6 (Ram 2022-12-05 11:45:15 +0200 4) }

Sekarang, git blame mengaitkan baris dengan komit yang betul, mengabaikan perubahan pemformatan yang tidak penting. Ini memberi kami maklumat berguna, menunjukkan siapa yang membuat perubahan fungsi sebenar.

Kesimpulan

Ciri .git-blame-ignore-revs dalam Git 2.23 ialah penukar permainan untuk projek dengan pemformatan pukal atau perubahan gaya. Dengan menyediakan fail .git-blame-ignore-revs dan mengkonfigurasi repositori anda, anda boleh menggunakan piawaian pengekodan, menjalankan alatan seperti Prettier atau kod refactor tanpa perlu risau tentang mencemarkan sejarah kesalahan.

Dengan pendekatan ini, pasukan anda dengan yakin boleh meningkatkan kualiti dan pemformatan kod tanpa mengorbankan keupayaan untuk menjejaki perubahan yang bermakna, memastikan git blame kekal sebagai alat yang berharga untuk memahami sejarah dan alasan di sebalik setiap baris kod.

Tentang kami:

Di Think Throo, kami berada dalam misi untuk mengajar konsep seni bina asas kod lanjutan yang digunakan dalam projek sumber terbuka.

10x kemahiran pengekodan anda dengan mempraktikkan konsep seni bina lanjutan dalam Next.js/React, pelajari amalan terbaik dan bina projek gred pengeluaran.

Kami adalah sumber terbuka — https://github.com/thinkthroo/thinkthroo (Beri kami bintang!)

Tingkatkan kemahiran pasukan anda dengan kursus lanjutan kami berdasarkan seni bina pangkalan kod. Hubungi kami di hello@thinkthroo.com untuk mengetahui lebih lanjut!

Rujukan:

1. https://github.com/facebook/react/blob/main/.git-blame-ignore-revs

2. https://gist.github.com/kateinoigakukun/b0bc920e587851bfffa98b9e279175f2

3. https://github.com/facebook/react/commit/c998bb1ed4b3285398c9c7797135d3f060243c6a

4. https://moxio.com/blog/ignoring-bulk-change-commits-with-git-blame/

Atas ialah kandungan terperinci `.git-blame-ignore-revs` untuk mengabaikan perubahan pemformatan pukal.. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!