shell linter

Раковина Линтер

Действие GitHub, которое выполняет статический анализ для сценариев оболочки с использованием ShellCheck.

Использование

Shell Linter может выполнять статический анализ по -разному. По умолчанию он сканирует все сценарии оболочки, поддерживаемых ShellCheck (SH/Bash/Dash/KSH) в вашем проекте. Тем не менее, вы можете использовать параметр path для сканирования конкретного файла или папки или использовать параметр exclude-paths для исключения файлов или папок из сканирования. С помощью Shell Linter вы также можете указать минимальную серьезность ошибок для рассмотрения использования параметра severity . Конкретные варианты использования вместе с примерами показаны ниже:

Запустите статический анализ всех поддерживаемых сценариев оболочки в вашем хранилище:

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

Запустите статический анализ для одного сценария оболочки:

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

Запустите статический анализ для нескольких сценариев оболочки с или без расширения:

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

Запустите статический анализ всех сценариев оболочки в папке:

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

Запустите статический анализ с помощью пути подстановочного знака :

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

Исключить файлы и папки из статического анализа:

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

Обратите внимание, что exclude-paths принимает только пути относительно корневого каталога вашего проекта. Однако не включайте ./ В начале пути.

Чтобы исключить папку, и она рекурсивно содержит, просто предоставьте путь папки без A / at Cons. В приведенном выше примере вся папка в tests/unit_tests будет исключена из личинга.

Запустите статический анализ всех сценариев оболочки и сообщите только о проблеме с ошибкой:

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

Запустите анализ с использованием конкретной версии Shell Linter:

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

Вход

path

Необязательный. Выполните проверку Lint в определенном файле или папке. По умолчанию: .

exclude-paths

Необязательный. Исключить файлы и папки из ShellCheck Scan.

severity

Необязательный. Укажите минимальную серьезность ошибок для рассмотрения [стиль, информация, предупреждение, ошибка]. По умолчанию: style

Лицензия

Это программное обеспечение доступно как открытый исходный код в условиях лицензии MIT.