Pemeriksa Makefile dan Alat Linting Terbaik

Pemeriksa Makefile adalah alat analisis statis yang membaca Makefile Anda dan memvalidasinya terhadap aturan tata bahasa GNU Make sebelum ada perintah shell yang dijalankan. Berbeda dengan menjalankan make --dry-run, pemeriksa tidak membutuhkan lingkungan build, alat yang terinstal, atau file sumber yang valid - ia bekerja murni pada teks Makefile.

Apa yang divalidasi

Permukaan validasi pemeriksa yang baik mencakup tiga lapisan. Validasi sintaks memastikan aturan target mengikuti format yang benar, baris resep dimulai dengan karakter TAB, dan penugasan variabel menggunakan operator yang valid. Validasi dependensi membangun graf prasyarat dan memeriksa bahwa setiap dependensi merujuk ke target yang terdefinisi atau file nyata. Validasi semantik menandai pola yang secara teknis valid tetapi secara konsisten menimbulkan masalah - seperti deklarasi .PHONY yang hilang pada target non-file.

• Lapisan sintaks - format aturan target, resep berindentasi TAB, operator penugasan variabel (`=`, `:=`, `?=`, `+=`)
• Lapisan dependensi - prasyarat yang belum teratasi, target tidak terdefinisi, dan rantai dependensi melingkar
• Lapisan semantik - deklarasi `.PHONY` yang hilang, definisi target ganda, dan blok resep kosong
• Lapisan gaya - indentasi tidak konsisten, baris panjang, dan pelanggaran konvensi penamaan (ditangani linter seperti checkmake)

Sebagian besar kegagalan Makefile berasal dari sekumpulan kesalahan berulang yang sedikit. Memahami masing-masing membantu Anda tahu apa yang harus dicari saat pemeriksa melaporkan masalah - dan mengapa itu penting.

Indentasi TAB vs spasi

Kesalahan Makefile paling umum juga yang paling membingungkan: baris resep harus dimulai dengan karakter TAB, bukan spasi. GNU Make dirancang pada 1976 dan persyaratan TAB tidak pernah dihapus. Editor modern bawaan memakai spasi, dan banyak yang diam-diam mengonversi tab menjadi spasi saat menyimpan. Hasilnya adalah Makefile yang tampak terformat sempurna di layar tetapi gagal dengan error "missing separator" yang membingungkan saat runtime.

build:
    gcc -o app main.c   # ← diindentasi 4 spasi - make akan menolak ini

build:
	gcc -o app main.c   # ← diindentasi dengan TAB - benar

Prasyarat yang belum teratasi

Ketika sebuah target mencantumkan prasyarat yang tidak merujuk ke target terdefinisi maupun file yang ada, make diam-diam melewati dependensi tersebut atau gagal dengan "No rule to make target". Pemeriksa menangkapnya pada waktu analisis statis dengan membangun graf dependensi lengkap dan menandai setiap referensi menggantung sebelum Anda menjalankan satu pun perintah.

Dependensi melingkar

Dependensi melingkar terjadi ketika target A bergantung pada B, dan B bergantung (langsung atau tidak langsung) pada A. GNU Make mencetak peringatan dan membuang aturan melingkar itu, artinya sebagian build Anda diam-diam tidak berjalan. Pemeriksa yang membangun graf dependensi mendeteksi siklus sebelum eksekusi dan melaporkan target persis yang terlibat - sesuatu yang tidak ditampilkan jelas oleh peringatan runtime make untuk rantai panjang.

Deklarasi .PHONY yang hilang

Target seperti clean, test, all, dan install adalah nama konvensional yang tidak menghasilkan file keluaran. Tanpa deklarasi .PHONY, make memeriksa apakah ada file bernama "clean" di direktori. Jika ada, make menganggap target sudah mutakhir dan melewatkan resepnya sepenuhnya - tanpa error, tanpa keluaran, hanya kegagalan diam-diam. Setiap target non-file sebaiknya tercantum di .PHONY.

Pemeriksa Makefile berbasis browser adalah cara tercepat memvalidasi file tanpa menginstal apa pun. Berguna untuk pemeriksaan cepat, untuk developer yang bekerja di lingkungan tempat mereka tak bisa memasang alat CLI, atau untuk meninjau Makefile yang dikirim orang lain.

Tidak ada satu pun pemeriksa Makefile "terbaik" untuk semua situasi. Alat yang tepat bergantung pada apakah Anda butuh pemeriksaan sekali cepat, integrasi pipeline CI, atau umpan balik editor real-time. Berikut perbandingan opsi-opsi utamanya.

Baris resep harus dimulai dengan karakter tab. Ini adalah persyaratan lama GNU Make yang tidak bisa diganggu oleh utilitas atau default IDE mana pun - hanya konfigurasi editor yang tepat atau pemeriksa statis yang akan menemukannya sebelum make.

Makefile Syntax and Dependency Checker dari Aback Tools

Pemeriksa Aback Tools adalah pilihan terbaik saat Anda ingin hasil instan tanpa penyiapan apa pun. Ia memvalidasi sintaks, indentasi TAB, resolusi prasyarat, dan graf dependensi melingkar sepenuhnya di browser. Tanpa instalasi, tanpa unggah server, tanpa login. Sangat berguna untuk meninjau Makefile di lingkungan tempat Anda tak bisa memasang alat CLI - mesin remote, langkah tinjauan CI, atau lingkungan bersama dengan izin terbatas.

checkmake (CLI)

checkmake adalah linter CLI open source yang ditulis dalam Go, tersedia di GitHub di mrtazz/checkmake. Ia berfokus pada penegakan gaya dan konvensi: deklarasi aturan phony minimal, panjang baris maksimum, keberadaan deskripsi target, dan pola penamaan. Ringan dan cepat, ideal untuk hook pre-commit atau alur kerja CI tempat Anda ingin menegakkan konvensi Makefile lintas tim secara otomatis.

Ekstensi VS Code Makefile Tools

Ekstensi resmi Makefile Tools dari Microsoft untuk VS Code menyediakan IntelliSense real-time untuk target dan variabel, penyorotan error inline untuk masalah sintaks umum, dan panel penjelajah target. Pilihan terbaik bagi developer yang sering menulis Makefile dan menginginkan umpan balik native editor tanpa pindah ke alat terpisah. Ia tidak memvalidasi graf dependensi sedalam pemeriksa khusus, tetapi langsung menangkap sebagian besar kesalahan sehari-hari.

make --dry-run (bawaan)

Menjalankan make -n atau make --dry-run mengeksekusi logika build tanpa menjalankan perintah shell apa pun. Berguna untuk memverifikasi bahwa target dan perintah yang tepat terpilih, tetapi membutuhkan lingkungan build lengkap - semua prasyarat harus terpenuhi, dan alat ini tidak memberi keluaran error terstruktur. Gunakan sebagai pemeriksaan akhir setelah pemeriksa khusus memvalidasi struktur file.

Menambahkan validasi Makefile ke pipeline CI Anda mencegah regresi ter-merge tanpa terdeteksi. Penyiapannya ringan - satu langkah workflow yang menggagalkan build jika pemeriksa melaporkan kesalahan.

GitHub Actions dengan checkmake

checkmake tersedia sebagai binary prakompilasi untuk Linux dan macOS, memudahkan instalasi di runner GitHub Actions. Tambahkan job yang menginstal binary dan menjalankannya terhadap Makefile Anda - langkah itu gagal dengan kode keluar bukan nol jika ditemukan pelanggaran aturan, memblokir merge pull request.

name: Lint Makefile

on:
  pull_request:
    paths:
      - 'Makefile'
      - '**/Makefile'

jobs:
  lint:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Install checkmake
        run: |
          curl -sSfL https://github.com/mrtazz/checkmake/releases/latest/download/checkmake-linux-amd64 \\
            -o /usr/local/bin/checkmake
          chmod +x /usr/local/bin/checkmake

      - name: Run checkmake
        run: checkmake Makefile

Hook pre-commit

Untuk penegakan lokal sebelum kode mencapai CI, tambahkan hook pre-commit yang menjalankan checkmake terhadap perubahan Makefile yang di-stage. Framework pre-commit mendukungnya secara native dan terintegrasi mulus dengan alur kerja Git apa pun.

repos:
  - repo: local
    hooks:
      - id: checkmake
        name: Lint Makefile
        language: system
        entry: checkmake
        files: ^Makefile$|/Makefile$
        pass_filenames: true

Menjalankan pemeriksa setelah menulis Makefile adalah jaring pengaman. Menulis Makefile dengan benar sejak awal adalah praktik yang membuat jaring pengaman jarang diperlukan. Kebiasaan-kebiasaan ini menghilangkan kesalahan paling umum sebelum muncul.

Konfigurasikan editor Anda untuk indentasi TAB

Setiap editor yang bawaannya memakai spasi perlu konfigurasi eksplisit untuk menggunakan TAB di file Makefile. Di VS Code, tambahkan pengaturan workspace atau per-bahasa yang membuat editor menyisipkan karakter TAB literal saat bekerja di file bernama Makefile. Di Vim dan Neovim, pola autocmd untuk file Makefile sudah standar dan terdokumentasi baik. Di IDE JetBrains, file Makefile otomatis terdeteksi dan diindentasi dengan TAB.

{
  "[makefile]": {
    "editor.insertSpaces": false,
    "editor.detectIndentation": false
  }
}

Selalu deklarasikan .PHONY untuk target non-file

Cantumkan di bawah .PHONY di bagian atas Makefile setiap target yang tidak menghasilkan file keluaran. Daftar konvensionalnya mencakup all, clean, install, test, lint, build, run, dan target aksi lain yang didefinisikan proyek Anda. Ini salah satu konvensi Makefile terpenting dan yang ditegakkan checkmake secara default.

• Deklarasikan .PHONY sejak awal - letakkan dekat bagian atas Makefile agar terlihat oleh setiap pembaca dan setiap pemeriksa
• Sertakan semua target aksi - target mana pun yang resepnya selalu ingin Anda jalankan, apa pun kondisi file, termasuk di .PHONY
• Gunakan satu deklarasi .PHONY - cantumkan semua target phony dalam satu blok alih-alih deklarasi terpisah yang tersebar di file
• Dokumentasikan target default - target pertama di Makefile adalah default; beri nama `all` dan dokumentasikan apa yang dibangunnya
• Beri prefix pada target debug - target internal atau debugging seperti `debug-vars` atau `print-PATH` lebih kecil kemungkinannya berbenturan dengan file nyata jika diberi prefix

Jaga prasyarat tetap datar dan eksplisit

Rantai prasyarat yang dalam lebih sulit divalidasi dan lebih mudah rusak. Bila memungkinkan, jaga graf dependensi tetap dangkal - satu atau dua tingkat - dan rujuk file secara eksplisit alih-alih mengandalkan aturan implisit. Aturan pola implisit seperti `%.o: %.c` adalah sintaks GNU Make yang valid, tetapi lebih sulit diselesaikan sepenuhnya oleh pemeriksa statis dan membuat graf dependensi kurang jelas bagi siapa pun yang membaca file.

Pemeriksa Makefile statis sangat kuat tetapi bekerja pada teks file. Ia tidak bisa melihat status runtime, isi sistem file, atau ketersediaan alat. Ada kategori masalah Makefile yang tak bisa ditangkap secara statis oleh pemeriksa mana pun.

Variabel tak terdefinisi mengembang diam-diam

Di GNU Make, merujuk variabel yang tak terdefinisi mengembang ke string kosong tanpa error apa pun. Resep yang seharusnya menjalankan gcc $(CFLAGS) -o app main.c akan menjalankan gcc -o app main.c jika CFLAGS tak terdefinisi - berpotensi mengompilasi tanpa flag yang diperlukan dan menghasilkan binary yang bekerja lokal tetapi gagal di produksi. Pemeriksa tidak bisa mengetahui nilai CFLAGS yang Anda maksud, sehingga kategori bug ini butuh pengujian runtime atau pemeriksaan variabel kondisional di Makefile itu sendiri.

Resolusi aturan implisit saat runtime

GNU Make memiliki sekumpulan besar aturan implisit bawaan - cara otomatis mengompilasi file .c menjadi .o, menautkan file objek, dan sebagainya. Pemeriksa statis tidak mensimulasikan aturan-aturan ini, sehingga Makefile yang sangat bergantung pada aturan implisit bisa lolos pemeriksaan dengan bersih tetapi gagal saat runtime jika alat yang diasumsikan tidak terinstal. Aturan eksplisit dengan resep yang terdefinisi selalu lebih aman dan portabel.

Ketergantungan pada status sistem file

Target yang bergantung pada file yang dihasilkan target sebelumnya - file objek, header terkompilasi, kode sumber yang dihasilkan - benar saat runtime tetapi tidak dapat divalidasi secara statis karena file prasyaratnya belum ada sampai make berjalan. Untuk kasus ini, make --dry-run yang dipadukan dengan lingkungan build lengkap adalah pelengkap yang tepat bagi pemeriksa statis. Kedua pendekatan mencakup mode kegagalan yang berbeda dan paling kuat saat dipakai bersama.