Mini Project: Refactor Existing Project — BAB 12
Tujuan Pembelajaran
Section titled “Tujuan Pembelajaran”Setelah menyelesaikan mini project ini, kamu diharapkan dapat:
- Merapikan struktur folder project yang berantakan menjadi modular.
- Mengonfigurasi ESLint dan Prettier di dalam project nyata secara mandiri.
- Meningkatkan kualitas keterbacaan kode program akademik sekolah.
Pendahuluan
Section titled “Pendahuluan”Kita akan mengambil project final akademik sekolah yang sudah kita buat di BAB 11, lalu melakukan operasi Refactor Kualitas Besar. Kita akan memasang pengawal otomatis (ESLint & Prettier), merapikan nama-nama variabel, membuang kode duplikat, dan menulis dokumentasi README yang stellar.
Penjelasan: Kebutuhan Refactor
Section titled “Penjelasan: Kebutuhan Refactor”Langkah-langkah yang harus dilakukan di projectmu:
- Configure Prettier: Buat file
.prettierrcdan aktifkan format otomatis di VS Code. - Configure ESLint: Aktifkan pemeriksaan variabel tak terpakai.
- Pembersihan DRY: Pastikan tidak ada
console.log("=".repeat(...))manual yang tersisa di seluruh file. - Dokumentasi: Tulis file
README.mdlengkap di folder root project.
Analogi Kehidupan Sehari-hari: Inspeksi Kerapian Kelas Sekolah
Section titled “Analogi Kehidupan Sehari-hari: Inspeksi Kerapian Kelas Sekolah”Mengatur linter dan formatter di project seperti mempersiapkan kelas untuk lomba kebersihan tingkat sekolah:
Inspeksi Kelas (ESLint & Prettier):- Guru memeriksa apakah ada sampah kertas terselip di laci meja (ESLint - mencari unused vars)- Petugas kebersihan menyapu lantai, merapikan taplak meja, dan meluruskan baris kursi (Prettier - format)Kelas tidak menjadi lebih luas, namun menjadi sangat bersih, wangi, dan nyaman untuk belajar.
Visual Illustration: Alur Kerja Refactoring Project
Section titled “Visual Illustration: Alur Kerja Refactoring Project”Project Awal (Berantakan) ──► Jalankan Prettier (Format) ──► Jalankan ESLint (Bersihkan) ──► Tulis READMELive Practice: Langkah Konfigurasi Alat bantu
Section titled “Live Practice: Langkah Konfigurasi Alat bantu”Langkah 1: Buat berkas .prettierrc di folder utama projectmu
Section titled “Langkah 1: Buat berkas .prettierrc di folder utama projectmu”{ "semi": true, "singleQuote": false, "tabWidth": 2, "trailingComma": "none"}Langkah 2: Buat berkas .gitignore (jika belum ada)
Section titled “Langkah 2: Buat berkas .gitignore (jika belum ada)”node_modules/dist/.envLangkah 3: Tulis README.md Lengkap
Section titled “Langkah 3: Tulis README.md Lengkap”Buat berkas README.md di folder root projectmu dan isi dengan informasi detail cara instalasi dan penggunaan aplikasi SIAKAD-Konsol.
Output
Section titled “Output”Ketika kamu menekan Ctrl + S, Prettier otomatis merapikan semua file kodemu secara seragam. VS Code akan menampilkan garis merah jika ada variabel yang dideklarasikan tapi tidak pernah dipakai (ESLint rule).
Common Mistakes
Section titled “Common Mistakes”- Lupa mengabaikan node_modules: Tidak membuat file
.prettierignoreatau.gitignoresehingga Prettier mencoba memformat jutaan baris kode library luar, membuat VS Code hang.
Best Practice
Section titled “Best Practice”- Selalu jalankan program dengan
npm run devsetelah melakukan pembersihan untuk menjamin logika program tetap utuh dan tidak rusak akibat salah hapus baris.
Ringkasan
Section titled “Ringkasan”- Mini Project berfokus meningkatkan kualitas kode project yang sudah ada (SIAKAD).
- Mengintegrasikan perkakas ESLint dan Prettier untuk otomatisasi kerapian.
- Menulis dokumentasi
README.mdlengkap sebagai wajah portofolio.
Latihan
Section titled “Latihan”- Terapkan seluruh langkah refactoring di atas pada project
siakad-finalkamu (BAB 11). - Pastikan file README ditulis dengan rapi menggunakan format Markdown.