shell linter

쉘 린터

Shellcheck을 사용하여 쉘 스크립트에 대한 정적 분석을 수행하는 GitHub 동작.

용법

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 Project의 루트 디렉토리와 관련된 경로 만 수락합니다. 그러나 경로의 시작 부분에는 포함 하지 마십시오 ./

폴더를 제외하고 컨텐츠는 재귀 적으로 폴더의 경로를 a / 끝에 제공하지 않고 제공합니다. 위의 예에서, 경로 tests/unit_tests 의 전체 폴더는 Linting에서 제외됩니다.

모든 쉘 스크립트에 대한 정적 분석을 실행하고 오류 심각도의 문제 만보 고하십시오.

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

특정 버전의 Shell Linter를 사용하여 분석 실행 :

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

입력

path

선택 과목. 특정 파일 또는 폴더에서 보풀 확인을 실행하십시오. 기본: .

exclude-paths

선택 과목. Shellcheck 스캔에서 파일과 폴더를 제외합니다.

severity

선택 과목. [스타일, 정보, 경고, 오류]를 고려할 오류의 최소 심각도를 지정하십시오. 기본값 : style

특허

이 소프트웨어는 MIT 라이센스의 조건에 따라 오픈 소스로 제공됩니다.