Solusi EGit
Orang akan berharap membuat atau mengubah variabel template pada proyek, ruang kerja, atau berbasis lingkungan adalah fitur Eclipse standar. Sayangnya tidak. Terlebih lagi, mengingat bahwa plugin Eclipse dapat menentukan variabel dan templat baru, harus ada plugin di luar sana yang menyediakan solusi. Jika ya, pasti sulit ditemukan. mmm-TemplateVariable , yang tersedia di Eclipse Marketplace, adalah langkah ke arah yang benar untuk pengguna Maven, memberikan kemampuan untuk memasukkan versi, artifactId, dll dalam templat.
Untungnya, EGit , yang merupakan alat Eclipse untuk Git, menyediakan cara yang sangat fleksibel untuk memasukkan berbagai variabel dalam templat kode. Satu-satunya persyaratan adalah bahwa proyek Anda menggunakan Git. Jika Anda tidak menggunakan Git, tetapi serius tentang pengembangan perangkat lunak, sekarang saatnya untuk belajar ( buku Pro Git ). Jika Anda terpaksa menggunakan sistem kontrol versi lama, coba ubah beberapa pikiran.
Berkat upaya harmsk , EGit 4.0 dan di atasnya mencakup kemampuan untuk menggunakan nilai-nilai kunci konfigurasi Git dalam templat. Ini memungkinkan pengaturan nilai template berdasarkan pengaturan repositori (proyek), pengaturan pengguna (akun), dan / atau pengaturan global (workstation).
Contoh berikut menunjukkan cara mengatur Eclipse dan Git untuk workstation pengembangan multi-pengguna dan menggunakan kunci konfigurasi Git khusus sebagai pengganti ${user}
untuk memberikan lebih banyak fleksibilitas. Meskipun contoh ini didasarkan pada instalasi Windows 10 dari Eclipse Mars dan Git untuk Windows, contoh ini berlaku untuk Linux dan OSX yang menjalankan Eclipse dan Git menggunakan masing-masing alat baris perintah.
Untuk menghindari kemungkinan kebingungan antara user.name
kunci konfigurasi Git dan user.name
properti sistem Java , kunci konfigurasi kustom Git - user.author
- akan digunakan untuk memberikan nama penulis dan / atau kredensial.
Mengkonfigurasi Template
Format variabel template Git adalah sebagai berikut
${<name>:git_config(<key>)}
di mana <name>
ada sembarang nama variabel dan <key>
merupakan kunci konfigurasi Git yang nilainya harus digunakan. Karena itu, ubah templat Komentar → Jenis menjadi
/**
* @author ${author:git_config(user.author)}
*
* ${tags}
*/
sekarang akan mencoba untuk menyelesaikan nama penulis dari user.author
kunci konfigurasi Git . Tanpa konfigurasi lebih lanjut, komentar apa pun yang baru dibuat tidak akan menyertakan nama setelah @author
, karena belum ada yang didefinisikan.
Mengkonfigurasi Git
Dari baris perintah
Konfigurasi Sistem Git - Langkah konfigurasi ini membuat perubahan pada konfigurasi seluruh sistem Git yang berlaku untuk semua akun di workstation kecuali ditimpa oleh pengaturan pengguna atau repositori. Karena konfigurasi seluruh sistem adalah bagian dari aplikasi Git yang mendasarinya (misalnya Git untuk Windows), perubahan akan memerlukan hak istimewa Administrator. Jalankan Git Bash, cmd, atau PowerShell sebagai Administrator. Perintah berikut akan mengatur penulis seluruh sistem.
git config --system user.author “SET ME IN GLOBAL(USER) or REPOSITORY(LOCAL) SETTINGS”
Tujuan dari "penulis" ini adalah untuk mengingatkan bahwa itu harus diatur di tempat lain. Ini sangat berguna ketika akun pengguna baru sedang digunakan di workstation.
Untuk memverifikasi pengaturan ini, buat proyek Java kosong yang menggunakan Git atau buka proyek berbasis Git yang ada. Buat kelas dan gunakan Sumber → Hasilkan Elemen Komentar dari menu konteks, ALT-SHIFT-J , atau mulai komentar JavaDoc. @author
Tag yang dihasilkan harus diikuti oleh peringatan.
Perubahan konfigurasi yang tersisa dapat dilakukan tanpa hak administrator.
Konfigurasi Git Global (Pengguna) - Global, atau pengguna, konfigurasi adalah yang terkait dengan pengguna tertentu dan akan mengesampingkan konfigurasi seluruh sistem. Pengaturan ini berlaku untuk semua proyek berbasis Git kecuali ditimpa oleh pengaturan repositori. Jika nama penulis berbeda karena berbagai jenis proyek seperti untuk pekerjaan, kontribusi sumber terbuka, atau pribadi, tetapkan yang paling sering digunakan di sini.
git config --global user.author “Mr. John Smith”
Setelah mengonfigurasi nilai global, kembalilah ke proyek uji yang digunakan lebih awal dan terapkan komentar kelas. The @author
tag sekarang harus menunjukkan pengaturan global.
Konfigurasi Git Repositori (Lokal) - Terakhir, konfigurasi repositori atau lokal dapat digunakan untuk mengonfigurasi penulis untuk proyek tertentu. Berbeda dengan konfigurasi sebelumnya, konfigurasi repositori harus dilakukan dari dalam repositori. Menggunakan Git Bash, PowerShell, dll. Menavigasi ke repositori proyek uji.
git config --local user.author “smithy”
Dengan ini, komentar baru dalam proyek uji akan menggunakan nama penulis yang ditentukan secara lokal. Proyek berbasis Git lainnya, masih akan menggunakan nama penulis global.
Dari Within Eclipse
Perubahan konfigurasi di atas juga dapat diatur dari dalam Eclipse melalui Preferensi: Tim → Git-Configuration . Eclipse harus dijalankan sebagai Administrator untuk mengubah konfigurasi Git seluruh sistem.
Alhasil
Meskipun contoh ini secara khusus menangani masalah yang paling umum, yaitu perubahan ${user}
, pendekatan ini dapat digunakan untuk lebih banyak hal. Namun, kehati-hatian harus dilakukan untuk tidak menggunakan kunci konfigurasi yang ditentukan Git, kecuali jika memang dimaksudkan secara khusus.