Skip to main content

Utilização

Instalação Rápida

Ainda não instalou? Use o instalador automático:

curl -fsSL https://raw.githubusercontent.com/rodrigocnascimento/zshellcheck/main/install-zshcheck.sh | bash

Veja mais opções na página de Instalação.

Uso Básico​

A forma mais simples de usar o ZshCheck é passar um ou mais arquivos:

zshcheck script.zsh

Analisando Múltiplos Arquivos​

# Todos os arquivos .zsh em um diretório
zshcheck scripts/*.zsh

Formatos de Saída​

Formato Tabela (padrão)​

zshcheck --format table script.zsh

Formato JSON​

zshcheck --format json script.zsh

Útil para CI/CD:

[
  {
    "code": "ZC1001",
    "severity": "warning",
    "message": "Variable '$HOME' should be quoted to prevent word splitting",
    "line": 10,
    "column": 6,
    "source": "echo $HOME"
  }
]

Formato Compacto​

zshcheck --format compact script.zsh

Saída:

script.zsh:10:6: warning: Variable '$HOME' should be quoted...

Filtros de Severidade​

# Mostrar apenas ERROR (mais severo)
zshcheck --max-severity error script.zsh

# Mostrar ERROR e WARNING
zshcheck --max-severity warning script.zsh

Filtrando Checks Específicos​

Incluir apenas alguns checks​

# Apenas ZC1001 e ZC2001
zshcheck --include ZC1001 --include ZC2001 script.zsh

Excluir checks específicos​

# Todos exceto ZC5001 (estilo)
zshcheck --exclude ZC5001 script.zsh

Listar Checks Disponíveis​

zshcheck --list-checks

Correção Automática​

Alguns problemas podem ser corrigidos automaticamente:

zshcheck script.zsh --fix

O ZshCheck vai perguntar para cada problema se deseja aplicar a correção, criar backup, e aplicar.

Códigos de Retorno​

CódigoSignificado
0Sucesso (nenhum erro encontrado)
1Erros encontrados ou falha na execução