shellcheck-configuration

Visão Geral

O que é shellcheck-configuration?

shellcheck-configuration é uma skill criada para ajudar desenvolvedores e equipes de DevOps a configurar e usar o ShellCheck, uma ferramenta de análise estática para scripts shell. Ela oferece orientações práticas para montar uma infraestrutura de linting, corrigir problemas de código e garantir a portabilidade dos scripts entre ambientes. Essa skill é ideal para quem deseja aplicar boas práticas, identificar erros comuns em scripts shell e integrar verificações de qualidade em pipelines de CI/CD.

Quem Deve Usar Esta Skill?

• Desenvolvedores que escrevem scripts Bash, sh, dash ou ksh
• Engenheiros de DevOps que mantêm scripts de automação
• Equipes que aplicam padrões de qualidade em scripts shell
• Qualquer pessoa que queira integrar linting de scripts shell em fluxos de CI/CD

Problemas Resolvidos

• Detecta erros comuns e armadilhas em scripts shell
• Garante padrões consistentes de codificação
• Auxilia na migração de scripts para atender critérios de qualidade
• Suporta configurações específicas do projeto e supressão de falsos positivos

Como Usar

Passos para Instalação

1. Instale a skill com:
   npx skills add https://github.com/wshobson/agents --skill shellcheck-configuration
2. Consulte o arquivo SKILL.md para orientações detalhadas sobre configuração e uso.
3. Explore arquivos de suporte como README.md, AGENTS.md e metadata.json para contexto adicional.

Configurando o ShellCheck

• Instale o ShellCheck usando o gerenciador de pacotes do seu sistema:
  • macOS: brew install shellcheck
  • Ubuntu/Debian: apt-get install shellcheck
  • A partir do código-fonte: clone o repositório oficial e execute make build && make install
• Verifique a instalação com shellcheck --version

Configurando o ShellCheck

• Crie um arquivo .shellcheckrc no seu projeto para personalizar regras e shells-alvo.
• Integre o ShellCheck ao seu pipeline de CI/CD para linting automatizado.
• Use flags do ShellCheck para ajustar a análise conforme as necessidades do seu projeto.

Adaptando o Fluxo de Trabalho

• Comece com os arquivos fornecidos pela skill e adapte a configuração para seu repositório e ferramentas.
• Evite copiar configurações literalmente; personalize para as necessidades da sua equipe e limitações do ambiente.

Perguntas Frequentes

Onde posso encontrar exemplos de configuração?

Confira os arquivos SKILL.md e .shellcheckrc para exemplos de configurações e práticas recomendadas.

Posso usar shellcheck-configuration em CI/CD?

Sim, a skill foi projetada para fácil integração em pipelines de CI/CD, permitindo linting e verificações de qualidade automatizadas de scripts shell.

Quais shells são suportados?

O ShellCheck suporta Bash, sh, dash, ksh e outros shells compatíveis com POSIX.

Como faço para suprimir falsos positivos?

Você pode configurar conjuntos de regras e suprimir avisos específicos no arquivo .shellcheckrc ou diretamente nos scripts.

Por onde devo começar?

Leia o arquivo SKILL.md para uma visão geral completa, depois explore os demais arquivos de suporte para aprofundar o contexto. Use a aba Arquivos para inspecionar toda a árvore de arquivos, incluindo referências e scripts auxiliares.