sleek

Pulcro

Sleek es una herramienta CLI para formatear SQL. Le ayuda a mantener un estilo consistente en su código SQL, mejorando la legibilidad y la productividad.

El trabajo pesado lo realiza la caja SQLFormat.

Antes y después

Aquí hay un ejemplo de una consulta SQL antes y después de ser formateada por Sleek:

Antes

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

Después

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

Características

• Formatear archivos SQL utilizando muescas personalizables y opciones de casos de caracteres
• Admite patrones de globas, lo que le permite formatear múltiples archivos y patrones
• Compruebe si sus archivos SQL ya están formateados sin alterarlos con la bandera --check

Instalación

Descargar binarios compilados

Puede descargar los binarios compilados para Sleek desde la página de lanzamientos de GitHub. Elija el binario que corresponde a su sistema operativo y arquitectura, y colóquelo en un directorio incluido en la variable de entorno PATH de su sistema.

Instalar con carga

Para instalar elegante con carga, deberá tener el óxido instalado en su sistema. Una vez que se instala el óxido, puede instalar elegante con carga:

cargo install sleek

Uso

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

Argumentos

• <file_paths>... : Patones (s) de archivo para formatear, admite patrones de globas. Si no se proporcionan rutas de archivo, se lee desde Stdin.

Banderas

• -c , --check : verifique si el código ya está formateado. Si no, saldrá con un mensaje de error.
• -h , --help : imprime información de ayuda.
• -V , --version : imprime información de la versión.

Opción

• -i , --indent_spaces <indent_spaces> : Establezca el número de espacios que se usarán para la sangría (predeterminado: 4).
• -U , --uppercase <uppercase> : Cambie las palabras clave reservadas a todos los límites (predeterminado: verdadero).
• -l , --lines_between_queries <lines_between_queries> : Establezca el número de saltos de línea después de una consulta (predeterminada: 2).

Ejemplos

Formatear una consulta de Stdin:

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

Para verificar si una consulta está formateada correctamente desde Stdin:

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

Para formatear un solo archivo con las opciones predeterminadas:

sleek my_query.sql

Para formatear múltiples archivos utilizando un patrón de globo:

sleek " queries/*.sql "

Para formatear archivos con opciones personalizadas:

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

Para verificar si los archivos ya están formateados:

sleek --check " queries/*.sql " 

Licencia

Este proyecto está disponible bajo la licencia MIT.