Lewati ke konten
🛠️ToolsShed

EditorConfig Generator

Hasilkan file .editorconfig untuk gaya koding konsisten di seluruh editor.

# EditorConfig — https://editorconfig.org
root = true

[*]
indent_style = space
indent_size = 2
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
max_line_length = 120

[*.json]
indent_size = 2

[*.md]
trim_trailing_whitespace = false

Tentang alat ini

EditorConfig adalah format file konfigurasi yang membantu tim pengembangan mempertahankan gaya pemformatan kode yang konsisten di berbagai editor dan IDE. Ketika anggota tim menggunakan editor yang berbeda—Visual Studio Code, JetBrains IDE, Sublime Text, Vim, atau lainnya—file .editorconfig memastikan bahwa indentasi, akhir baris, set karakter, dan aturan pemformatan lainnya tetap seragam terlepas dari alat mana yang disukai setiap orang. Ini menghilangkan konflik pemformatan dalam sistem kontrol versi dan mengurangi waktu yang dihabiskan untuk diskusi gaya.

Untuk menggunakan generator ini, cukup pilih pengaturan pilihan Anda untuk jenis indentasi (tab atau spasi), ukuran indentasi, gaya akhir baris (LF, CRLF, atau deteksi otomatis), dan set karakter. Anda juga dapat mengonfigurasi aturan untuk jenis file tertentu seperti Python, JavaScript, JSON, atau bahasa lain yang Anda gunakan. Setelah menyesuaikan semua pengaturan, unduh file .editorconfig yang dihasilkan dan letakkan di direktori root proyek Anda. Editor anggota tim Anda akan secara otomatis menerapkan aturan ini saat membuka file di proyek tersebut.

EditorConfig terintegrasi dengan mulus dengan sebagian besar editor modern melalui dukungan bawaan atau plugin ringan, menjadikannya salah satu cara paling sederhana untuk menerapkan konsistensi gaya kode tanpa alat build atau linter tambahan. Tim yang mengerjakan proyek open source, basis kode perusahaan, atau lingkungan kolaboratif mendapat manfaat paling banyak, karena menciptakan satu sumber kebenaran untuk preferensi pemformatan. Alat ini sangat berguna untuk proyek poligot di mana berbagai bahasa pemrograman ada bersama, karena aturan .editorconfig dapat disesuaikan per ekstensi file.

Pertanyaan yang Sering Diajukan

Implementasi Kode

# Generate a .editorconfig file programmatically

def generate_editorconfig(indent_style="space", indent_size=2, end_of_line="lf",
                           charset="utf-8", trim_trailing_whitespace=True,
                           insert_final_newline=True) -> str:
    lines = [
        "# EditorConfig is awesome: https://editorconfig.org",
        "",
        "# top-most EditorConfig file",
        "root = true",
        "",
        "[*]",
        f"indent_style = {indent_style}",
        f"indent_size = {indent_size}",
        f"end_of_line = {end_of_line}",
        f"charset = {charset}",
        f"trim_trailing_whitespace = {str(trim_trailing_whitespace).lower()}",
        f"insert_final_newline = {str(insert_final_newline).lower()}",
        "",
        "[*.md]",
        "trim_trailing_whitespace = false",
        "",
        "[Makefile]",
        "indent_style = tab",
        "",
        "[*.{json,yml,yaml}]",
        "indent_size = 2",
    ]
    return "\n".join(lines)

config = generate_editorconfig(indent_style="space", indent_size=4)
print(config)

# Write to file
with open(".editorconfig", "w") as f:
    f.write(config)

Comments & Feedback

Comments are powered by Giscus. Sign in with GitHub to leave a comment.