Membiasakan Rapih Dalam Menulis Kode

EditorConfig For Visual Studio Code

Biasakan rapih menulis kode di dalam sebuah tim

Bismillahirrahmanirahim kali ini saya akan berbagi sedikit tulisan bagaimana sih kita supaya disiplin dalam menulis kode dan keliatan nya rapih dilihatnya ketika kode berpindah dari editor kita ke editor rekan kerja kita, ketika berada di dalam sebuah tim, tidak bisa dipungkiri lagi jika kita berada di dalam sebuah tim biasanya editor yang digunakan bisa berbeda tergantung dari kebiasan programmer nya, dia biasa menggunakan editor apa. Syukur-syukur menggunakan teks editor yang sama akan tetapi ketika editor sama pun jika rule tiap editor nya berbeda nanti akan tidka rapih keliatan nya.

Kenapa harus ada aturan ???

Yup di dalam manajemen projek di divisi engineer harus ada aturan yang menuntut programmer ketika menulis beberapa baris kode itu harus menggunakan aturan supaya apa ?, untuk mendisiplinkan dan menjadi suatu kebiasaaan bagi programmer ketika menulis kode tidak asal nulis aja tapi harus memenuhi aturan nya, manfaatnya nanti supaya lebih mudah juga ketika akan maintenance kedepan nya oleh programmer lain. Pernah kah kalian menemukan contoh kecil indent yang tidak rapih ketika kalian membuat sebuah file a di editor kalian indent size nya di set 3 rapih kelihatan nya, terus kalian selesai mengerjakan file a itu, suatu saat kalian sedang sakit, lalu ada bug di file a tersebut teman kalian mencoba mengerjakan nya dengan setingan editor indent size nya 4 lalu push dan selesai dikerjakan oleh teman kalian. Selanjutnya kalian pull code terbaru dan membuka file a tersebut nanti kalian akan merasa ada yang aneh perasaan indent nya udah pas kenapa jadi berubah ???, mungkin kalian akan bertanya-tanya kenapa sih bisa seperti itu ? kurang lebih gambaran nya code nya jadi seperti ini.

Sebelum di ubah

Setelah di ubah

Baca Juga : Boilerplate Expressjs Dengan Docker Compose dan MongoDB

Hal ini lumrah terjadi jika kita tidak menerapkan aturan di projek aplikasi kita, syukur-syukur semua developer ketika mengerjakan semuanya mempunyai setingan indent size yang sama gimana jika beda keliatan nya akan tidak beraturan dan tidak enak dilihat saja sih itu menurut saya pribadi.

Berikut tips untuk kalian ketika mengerjakan aplikasi di dalam sebuah tim supaya semuanya mempunyai rule yang sama walaupun beda editor ataupun sama edior nya.

Hal sederhana yang dilakukan

Menginstall ekstension editorconfig apa itu editor config ? editor config adalah sebuah tools atau ekstension yang membantu mempertahankan gaya pengkodean yang konsisten untuk banyak pengembang yang mengerjakan proyek yang sama di berbagai editor dan IDE. Proyek EditorConfig terdiri dari format file untuk menentukan gaya pengkodean dan kumpulan plugin editor teks yang memungkinkan editor membaca format file dan mengikuti gaya yang ditentukan. File EditorConfig mudah dibaca dan bekerja dengan baik dengan sistem kontrol versi. sumber dari situs resminya https://editorconfig.org/.

Editorconfig menjadi salah satu pilihan untuk kita menjadi konsisten dalam menulis baris kode, sebenarnya ada yang lebih bagus jika menggunakan JS bisa menggunakan eslint tapi bagi pemula saya tidak menyarankan itu sih karena eslint sangat keras hehehe. Masih banyak ekstension atau tools yang support untuk beberapa pemrograman tapi biasanya berbeda-beda nama toolsnya jadi alasan memilih editorconfig kita biasa menyesuaikan untuk berbagai bahasa. Dan juga mungkin karena bisa support beberapa teks editor seperti pada gambar dibawah ini

EditorConfig

Untuk menginstall nya jika teman-teman menggunakan visual studio code bisa cari di extensions market place ketikan editorconfig lalu pilih editor config for VS code, setelah ketemu install dan tunggu sampai prosess install selesai setelah selesai biasanya teks editor meminta untuk reload, klik reload sampai terestar kembali editor anda.

Baca Juga : Membuat Mockup API dengan Json Server

Jika sudah terinstall di editor teman-teman cara menggunakan nya yaitu klik kanan di bagian explorer nama projek teman-teman lalu pilih generate .editorconfig bagian bawah seperti apda gamabar ini

Generate .editorconfig

Setelah di klik maka akan ada file baru di root projek teman-teman dengan nama .editorconfig oh iya jangan lupa klik kanan nya di root projek teman-teman ya, setelah itu klik file .editorconfig tersebut dan ubah kebutuhan nya sesuai dengan kesepakatan dengan teman-teman satu tim kalian berikut penjelasan singkatnya.

kode .editorconfig

Sebagai catatan semua itu akan berfungsi syaratnya di semua teks editor di dalam tim harus menginstall ekstension editorconfig tersebut. 

Mungkin segitu artikel yang bisa saya share kepada teman-teman ingat harus berani melakukan perubahan di dalam manajemen tim supaya konsisten dan mempunyai style dalam gaya penulisan kode ddi dalam sebuah tim, mari menjadi kuli coding yang baik dan benar untuk indonesia yang lebih baik hehehe, semoga bermanfa'at dan berkah.