sleek

Lisse

Sleek est un outil CLI pour la mise en forme de SQL. Il vous aide à maintenir un style cohérent sur votre code SQL, améliorant la lisibilité et la productivité.

Le levage de lourds est effectué par la caisse sqlformat.

Avant et après

Voici un exemple de requête SQL avant et après avoir été formaté par Sleek:

Avant

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

Après

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

Caractéristiques

• Format des fichiers SQL à l'aide d'options de cas d'indentation et de caractéristiques personnalisables
• Prend en charge les modèles GLOB, vous permettant de formater plusieurs fichiers et modèles
• Vérifiez si vos fichiers SQL sont déjà formatés sans les modifier avec le drapeau --check

Installation

Télécharger les binaires compilés

Vous pouvez télécharger les binaires compilés pour Sleek à partir de la page GitHub Release. Choisissez le binaire qui correspond à votre système d'exploitation et à votre architecture, et placez-le dans un répertoire inclus dans la variable d'environnement PATH de votre système.

Installer avec cargaison

Pour installer Sleek à l'aide de la cargaison, vous devrez faire installer de la rouille sur votre système. Une fois la rouille installée, vous pouvez installer Sleek avec du fret:

cargo install sleek

Usage

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

Arguments

• <file_paths>... : Chemin de fichier (s) au format, prend en charge les modèles GLOB. Si aucun chemin de fichier n'est fourni, il se lit sur stdin.

Drapeaux

• -c , --check : Vérifiez si le code est déjà formaté. Sinon, il sortira avec un message d'erreur.
• -h , --help : imprime les informations d'aide.
• -V , --version : imprime les informations de version.

Options

• -i , --indent_spaces <indent_spaces> : Définissez le nombre d'espaces à utiliser pour l'indentation (par défaut: 4).
• -U , --uppercase <uppercase> : modifiez les mots clés réservés à tous les CAP (par défaut: true).
• -l , --lines_between_queries <lines_between_queries> : Définissez le nombre de ruptures de ligne après une requête (par défaut: 2).

Exemples

Format une requête de Stdin:

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

Pour vérifier si une requête est formatée correctement à partir de stdin:

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

Pour formater un seul fichier avec les options par défaut:

sleek my_query.sql

Pour formater plusieurs fichiers à l'aide d'un modèle glob:

sleek " queries/*.sql "

Pour formater des fichiers avec des options personnalisées:

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

Pour vérifier si les fichiers sont déjà formatés:

sleek --check " queries/*.sql " 

Licence

Ce projet est disponible sous la licence MIT.