shell linter

Linte de concha

Uma ação do GitHub que executa uma análise estática para scripts de shell usando shellcheck.

Uso

O Shell Linter pode realizar análises estáticas de várias maneiras. Por padrão, ele digitaliza todos os scripts de shell suportados por shellcheck (SH/Bash/Dash/Ksh) em seu projeto. No entanto, você pode usar o parâmetro path para digitalizar um arquivo ou pasta específica ou usar o parâmetro exclude-paths para excluir arquivos ou pastas da verificação. Com o Shell Linter, você também pode especificar a gravidade mínima dos erros para considerar o uso do parâmetro severity . Casos de uso específicos, juntamente com exemplos, são mostrados abaixo:

Execute a análise estática para todos os scripts de shell suportados em seu repositório:

 jobs :
  lint :
    runs-on : ubuntu-latest
    steps :
      - name : Checkout code
        uses : actions/checkout@v1
      - name : Run ShellCheck
        uses : azohra/shell-linter@latest 

Execute a análise estática para um único script de shell:

      - name : Run ShellCheck
        uses : azohra/shell-linter@latest
        with :
          path : " setup.sh " 

Execute a análise estática para vários scripts de shell com ou sem extensão:

      - name : Run ShellCheck
        uses : azohra/shell-linter@latest
        with :
          path : " setup,deploy.sh " 

Execute a análise estática para todos os scripts do shell em uma pasta:

      - name : Run ShellCheck
        uses : azohra/shell-linter@latest
        with :
          path : " src " 

Execute a análise estática usando um caminho curinga :

      - name : Run ShellCheck
        uses : azohra/shell-linter@latest
        with :
          path : " src/*.sh " 

Exclua arquivos e pastas da análise estática:

      - name : Run ShellCheck
        uses : azohra/shell-linter@latest
        with :
          exclude-paths : " src/setup.sh,tests/unit_tests " 

Observe que o exclude-paths aceita apenas caminhos em relação ao diretório raiz do seu projeto. No entanto, não inclua ./ No início dos caminhos.

Para excluir uma pasta e seu conteúdo, apenas fornece o caminho da pasta sem A / no final. No exemplo acima, a pasta inteira nos tests/unit_tests será excluída do linhagem.

Execute a análise estática para todos os scripts do shell e apenas relate problemas com a gravidade do erro:

      - name : Run ShellCheck
        uses : azohra/shell-linter@latest
        with :
          path : " src/*.sh "
          severity : " error " 

Execute a análise usando uma versão específica do shell liner:

      - name : Run ShellCheck
        uses : azohra/[email protected]

Entrada

path

Opcional. Execute a verificação de fiapos em um arquivo ou pasta específica. Padrão: .

exclude-paths

Opcional. Exclua arquivos e pastas da shellcheck Scan.

severity

Opcional. Especifique a gravidade mínima dos erros para considerar [estilo, informações, aviso, erro]. Padrão: style

Licença

Este software está disponível como código aberto nos termos da licença do MIT.