sleek

Elegante

Sleek é uma ferramenta CLI para formatar SQL. Ajuda você a manter um estilo consistente em seu código SQL, aumentando a legibilidade e a produtividade.

O levantamento pesado é feito pela caixa sqlformat.

Antes e depois

Aqui está um exemplo de uma consulta SQL antes e depois de ser formatada pela Sleek:

Antes

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

Depois

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

Características

• Formatar arquivos SQL usando opções personalizáveis ​​de indentação e caso de caracteres
• Suporta padrões globais, permitindo que você formate vários arquivos e padrões
• Verifique se seus arquivos SQL já estão formatados sem alterá -los com a bandeira --check

Instalação

Baixar binários compilados

Você pode fazer o download dos binários compilados para a página Sleek na página do GitHub. Escolha o binário que corresponde ao seu sistema operacional e arquitetura e coloque -o em um diretório incluído na variável de ambiente de PATH do sistema.

Instale com carga

Para instalar elegante usando carga, você precisará instalar a ferrugem no seu sistema. Depois que a ferrugem é instalada, você pode instalar elegante com carga:

cargo install sleek

Uso

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

Argumentos

• <file_paths>... : Caminhos (s) de arquivo para formatar, suporta padrões do GLOB. Se não forem fornecidos caminhos de arquivo, leituras do stdin.

Bandeiras

• -c , --check : verifique se o código já está formatado. Caso contrário, ele sairá com uma mensagem de erro.
• -h , --help : impressões ajudam informações.
• -V , --version : imprime as informações da versão.

Opções

• -i , --indent_spaces <indent_spaces> : Defina o número de espaços a serem usados ​​para o indentação (padrão: 4).
• -U , --uppercase <uppercase> : altere as palavras -chave reservadas para todas as caps (padrão: true).
• -l , --lines_between_queries <lines_between_queries> : Defina o número de quebras de linha após uma consulta (padrão: 2).

Exemplos

Formate uma consulta de Stdin:

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

Para verificar se uma consulta é formatada corretamente a partir de stdin:

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

Para formatar um único arquivo com as opções padrão:

sleek my_query.sql

Para formatar vários arquivos usando um padrão glob:

sleek " queries/*.sql "

Para formatar arquivos com opções personalizadas:

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

Para verificar se os arquivos já estão formatados:

sleek --check " queries/*.sql " 

Licença

Este projeto está disponível sob a licença do MIT.