데이터베이스 추가 진단

참고 항목

이 콘텐츠는 CodeQL CLI의 최신 릴리스에 대해 설명합니다. 이 요소에 대한 자세한 내용은 https://github.com/github/codeql-cli-binaries/releases을(를) 참조하세요.

이전 릴리스에서 이 명령에 사용할 수 있는 옵션의 세부 정보를 보려면 터미널에서 옵션을 사용하여 --help 명령을 실행합니다.

개요

Shell

codeql database add-diagnostic --source-id=<id> --source-name=<name> <options>... -- <database>

codeql database add-diagnostic --source-id=<id> --source-name=<name> <options>... -- <database>

Description

          \[실험적] 데이터베이스에 진단 정보를 추가합니다.

v2.12.6부터 사용할 수 있습니다.

Options

기본 옵션

`<database>`

          \[필수] 번들화할 CodeQL 데이터베이스에 대한 경로입니다.

`--markdown-message=<markdownMessage>`

진단 메시지입니다(GitHub Flavored Markdown 형식).

`--plaintext-message=<plaintextMessage>`

진단 메시지(일반 텍스트)입니다. 이 옵션은 –markdown-message를 사용하여 마크다운 메시지를 작성하는 것이 비효율적인 경우에만 제한적으로 사용해야 합니다.

`--severity=<severity>`

진단의 심각도입니다. "error", "warning" 또는 "note"일 수 있습니다.

`--help-link=<helpLinks>`

진단 관련 도움말 링크입니다.

`--attributes-json=<attributesJson>`

진단과 관련된 구조화된 메타데이터입니다.

진단 메시지를 표시할 수 있는 위치를 나타내는 옵션

`--ready-for-status-page`

진단 결과가 상태 페이지에 표시하기 적합한 상태임을 나타냅니다.

`--ready-for-cli-summary-table`

진단이 database analyze와 같은 명령으로 출력되는 진단 요약 테이블에 표시하기에 적합함을 나타냅니다.

진단 원본을 설명하는 옵션

`--source-id=<id>`

          \[필수] 이 진단의 원본에 대한 식별자입니다.

`--source-name=<name>`

          \[필수] 이 진단의 원본에 대한 사람이 읽을 수 있는 설명입니다.

`--extractor-name=<extractorName>`

CodeQL 추출기에서 이 진단이 생성된 경우, 해당 추출기의 이름을 나타냅니다.

진단 위치를 설명하는 옵션

`--file-path=<file>`

원본 루트를 기준으로 진단 대상이 되는 파일의 경로입니다.

`--start-line=<startLine>`

진단이 시작되는 위치는 1번 줄(포함)입니다.

`--start-column=<startColumn>`

진단이 시작되는 위치는 1번 열(포함)입니다.

`--end-line=<endLine>`

진단이 끝나는 위치는 1번 줄(포함)입니다.

`--end-column=<endColumn>`

진단이 끝나는 위치는 1번 열(포함)입니다.

일반 옵션

`-h, --help`

이 도움말 텍스트를 표시합니다.

`-J=<opt>`

          \[고급] 명령을 실행하는 JVM에 옵션을 제공합니다.

(옵션에 공백이 포함될 경우 처리가 정상적으로 이루어지지 않을 수 있으니 주의가 필요합니다.)

`-v, --verbose`

출력되는 진행률 메시지의 수를 점차 늘립니다.

`-q, --quiet`

출력되는 진행 상황 메시지의 빈도를 점차 줄여나갑니다.

`--verbosity=<level>`

          \[고급] 세부 정보 표시 수준을 명시적으로 오류, 경고, 진행률, 진행률+, 진행률++, 진행률+++ 중 하나로 설정합니다. 
          `-v` 및 `-q`를 재정의합니다.

`--logdir=<dir>`

          \[고급] 지정된 디렉터리에 하나 이상의 상세 로그 파일을 생성하며, 파일 이름에는 타임스탬프와 실행 중인 하위 명령 이름이 포함됩니다.

(로그 파일 이름을 직접 지정하려면 대신 --log-to-stderr 를 사용하고 stderr를 원하는 위치로 리디렉션하세요.)

`--common-caches=<dir>`

          \[고급] 다운로드한 QL 팩과 컴파일된 쿼리 계획 등, CLI를 여러 번 실행해도 유지되는 디스크에 캐시된 데이터의 위치를 제어합니다. 명시적으로 설정하지 않으면, 기본적으로 사용자의 홈 디렉터리에 지정된 `.codeql` 이름의 디렉터리로 설정됩니다. 디렉터리가 아직 존재하지 않는 경우, 새로 생성됩니다.

v2.15.2부터 사용할 수 있습니다.

누가 이 기능을 사용할 수 있나요?

이 문서의 내용

개요