Cara memakai
- Pilih indentasi di Indentasi dengan dan Ukuran indentasi. Pilih pemisah baris di Akhir baris dan pengodean di Set karakter.
- Centang bagian jenis berkas yang Anda perlukan: Pertahankan spasi di akhir pada Markdown, Indentasi YAML dengan dua spasi dan Indentasi resep Makefile dengan tab.
- Salin teks di Berkas .editorconfig, atau unduh, lalu simpan di folder paling atas proyek Anda.
- Baca Arti setiap baris untuk memeriksa apa yang dilakukan setiap properti.
Cara berkas bekerja
Banyak editor dan IDE membaca berkas .editorconfig dan menerapkan pengaturannya pada berkas yang cocok dengan setiap bagian. Judul bagian adalah pola nama berkas di dalam kurung siku, dan properti di bawahnya berlaku untuk setiap berkas yang cocok. Bagian yang lebih akhir menimpa bagian sebelumnya untuk properti yang sama. Baris root = true menghentikan pencarian, sehingga pengaturan hanya sampai ke folder ini dan folder di bawahnya.
- * cocok dengan karakter apa pun kecuali garis miring.
- ** cocok dengan karakter apa pun, termasuk garis miring.
- {yml,yaml} cocok dengan salah satu teks, sehingga *.{yml,yaml} cocok dengan kedua jenis berkas.
Bagian jenis berkas
- Markdown: dua spasi di akhir baris membuat pemisah baris, jadi pembuangan dimatikan untuk *.md.
- YAML: karakter tab tidak diizinkan untuk indentasi, jadi *.{yml,yaml} diindentasi dengan spasi, dua untuk setiap tingkat.
- Makefile: setiap baris resep harus diawali karakter tab, jadi Makefile mendapat indent_style = tab.
Memilih nilai
- Spasi adalah pilihan umum untuk kode. Tab cocok untuk tim yang editornya semua menampilkan tab dengan lebar yang sama.
- LF adalah pemisah baris yang lazim untuk proyek di Linux dan macOS serta di sebagian besar repositori. CRLF adalah pemisah baris berkas teks Windows.
- UTF-8 adalah pengodean standar. Gunakan UTF-8 dengan tanda urutan byte hanya ketika sebuah alat memerlukannya.
Contoh: pilihan bawaan
Dengan spasi, ukuran indentasi 2, LF, UTF-8, spasi di akhir dibuang, akhir berkas dengan pemisah baris, dan tiga bagian jenis berkas, berkas memiliki baris root, satu bagian untuk semua berkas dengan enam properti, serta satu properti di setiap bagian Markdown dan Makefile, ditambah dua di bagian YAML. Tabel mencantumkan sebelas baris properti, dan enam di antaranya ditampilkan di sini.
| Bagian | Properti | Nilai |
|---|---|---|
| Awal berkas | root | true |
| Semua berkas | indent_style | space |
| Semua berkas | indent_size | 2 |
| Markdown (.md) | trim_trailing_whitespace | false |
| YAML (.yml, .yaml) | indent_style | space |
| Makefile | indent_style | tab |
Pertanyaan yang sering diajukan
Di mana berkas .editorconfig harus diletakkan?
Di folder paling atas proyek, di samping README. Editor mencarinya di folder setiap berkas lalu di setiap folder di atasnya, dan pencarian berhenti di berkas pertama yang memiliki root = true.
Apakah berkas .editorconfig memformat ulang kode saya?
Tidak dengan sendirinya. Ia memberi tahu editor dan plugin indentasi, pemisah baris dan pengodean yang harus dipakai ketika mereka menyunting atau menyimpan berkas. Pemformat atau linter yang melakukan pemformatan ulang, dan sebagian dari mereka membaca pengaturan yang sama.
Mengapa bagian Markdown mempertahankan spasi di akhir?
Dalam Markdown, dua spasi di akhir baris membuat pemisah baris. Membuangnya akan menggabungkan dua baris menjadi satu, jadi bagian ini mematikan pembuangan hanya untuk berkas .md.
Mengapa Makefile harus memakai tab?
make membaca setiap baris resep setelah karakter tab, dan resep yang diawali spasi adalah galat. Bagian Makefile karena itu mengatur indent_style ke tab untuk berkas bernama Makefile.
Bisakah sebuah subfolder menghapus salah satu pengaturan ini?
Bisa, dengan nilai unset, yang menghapus properti yang diatur sebelumnya. Halaman ini hanya menulis nilai biasa, jadi tambahkan baris itu di berkas .editorconfig milik subfolder jika Anda memerlukannya.
Apakah berkas ini dikirim ke server?
Tidak. Berkas ditulis di peramban Anda dari pilihan yang Anda buat, dan tidak ada yang Anda pilih yang disimpan.
Sumber
- EditorConfig: the file format and the supported properties (dalam bahasa Inggris)
- EditorConfig specification: sections, globs and root (dalam bahasa Inggris)
- CommonMark 0.31.2: hard line breaks, two spaces at the end of a line (dalam bahasa Inggris)
- YAML 1.2.2: tab characters must not be used in indentation (dalam bahasa Inggris)
- GNU Make manual: a recipe line begins with a tab character (dalam bahasa Inggris)
Angka dan teks terakhir diperiksa pada Selasa, 10 November 2026.