sleek

Licin

Sleek adalah alat CLI untuk memformat SQL. Ini membantu Anda mempertahankan gaya yang konsisten di seluruh kode SQL Anda, meningkatkan keterbacaan dan produktivitas.

Pengangkatan berat dilakukan oleh peti SQLFORMAT.

Sebelum dan sesudah

Berikut adalah contoh permintaan SQL sebelum dan sesudah diformat oleh ramping:

Sebelum

 select id, name, email from users where id in ( select user_id from orders where total > 100 ) and status = ' active '

Setelah

 SELECT
    id,
    name,
    email
FROM
    users
WHERE
    id IN (
        SELECT
            user_id
        FROM
            orders
        WHERE
            total > 100
    )
    AND STATUS = ' active ' 

Fitur

• Format File SQL Menggunakan Opsi Indentasi dan Karakter Karakter yang Dapat Disesuaikan
• Mendukung Pola Glob, memungkinkan Anda untuk memformat banyak file dan pola
• Periksa apakah file SQL Anda sudah diformat tanpa mengubahnya dengan bendera --check

Instalasi

Unduh binari yang dikompilasi

Anda dapat mengunduh biner yang dikompilasi untuk ramping dari halaman Rilis GitHub. Pilih biner yang sesuai dengan sistem operasi dan arsitektur Anda, dan letakkan di direktori yang termasuk dalam variabel lingkungan PATH sistem Anda.

Pasang dengan kargo

Untuk memasang kargo menggunakan kargo, Anda harus memasang karat di sistem Anda. Setelah karat dipasang, Anda dapat memasang ramping dengan kargo:

cargo install sleek

Penggunaan

sleek [FLAGS] [OPTIONS] < file_paths > ...

Argumen

• <file_paths>... : PATH file untuk format, mendukung pola Glob. Jika tidak ada jalur file yang disediakan, dibaca dari Stdin.

Bendera

• -c , --check : Periksa apakah kode sudah diformat. Jika tidak, itu akan keluar dengan pesan kesalahan.
• -h , --help : mencetak informasi bantuan.
• -V , --version : Cetak informasi versi.

Opsi

• -i , --indent_spaces <indent_spaces> : atur jumlah spasi yang akan digunakan untuk indentasi (default: 4).
• -U , --uppercase <uppercase> : Ubah kata kunci yang dicadangkan ke semua caps (default: true).
• -l , --lines_between_queries <lines_between_queries> : Tetapkan jumlah jeda baris setelah kueri (default: 2).

Contoh

Format Kueri dari Stdin:

 > echo " select * from users " | sleek --uppercase
SELECT
    *
FROM
    user

Untuk memeriksa apakah kueri diformat dengan benar dari Stdin:

 > echo " select * from users " | sleek --check
Input is not formatted correctly. Run without --check to format the input.

Untuk memformat satu file dengan opsi default:

sleek my_query.sql

Untuk memformat beberapa file menggunakan pola glob:

sleek " queries/*.sql "

Untuk memformat file dengan opsi khusus:

sleek --indent_spaces 2 --uppercase false " queries/*.sql "

Untuk memeriksa apakah file sudah diformat:

sleek --check " queries/*.sql " 

Lisensi

Proyek ini tersedia di bawah lisensi MIT.