diagnostic add

概要

codeql diagnostic add (--diagnostic-dir=<diagnosticDir>) --source-id=<id> --source-name=<name> <options>...

codeql diagnostic add (--diagnostic-dir=<diagnosticDir>) --source-id=<id> --source-name=<name> <options>...

描述

[实验性] [底层] 添加诊断信息。

自 v2.12.6 起可用。

选项

主要选项

--markdown-message=<markdownMessage>

诊断信息的消息，采用 GitHub 风格的 Markdown 格式。

--plaintext-message=<plaintextMessage>

诊断信息的消息，纯文本格式。当使用 --markdown-message 填充 Markdown 消息不切实际时才应使用此选项。

--severity=<severity>

诊断的严重程度。可以是 “error”、 “warning” 或 “note”。

--help-link=<helpLinks>

与诊断相关的帮助链接。

--attributes-json=<attributesJson>

与诊断相关的结构化元数据。

指定保存诊断信息位置的选项

必须只提供上述选项中的一个。

--diagnostic-dir=<diagnosticDir>

应将诊断信息添加到的目录。

指示诊断消息可以显示位置的选项

--ready-for-status-page

指示该诊断适合在状态页上显示。

--ready-for-cli-summary-table

指示该诊断适合在如 database analyze 等命令输出的诊断摘要表中显示。

描述诊断来源的选项

--source-id=<id>

[必需] 此诊断来源的标识符。

--source-name=<name>

[必需] 对此诊断来源的可读描述。

--extractor-name=<extractorName>

CodeQL 提取器的名称（如果该诊断由 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>

[高级] 将详细程度显式设置为以下之一：errors、warnings、progress、progress+、progress++、progress+++。会覆盖 -v 和 -q。

--logdir=<dir>

[高级] 将详细日志写入指定目录中的一个或多个文件，文件名会包含时间戳和运行的子命令名称。

（若希望自行完全控制日志文件名，请改用 --log-to-stderr 并按需重定向 stderr。）

--common-caches=<dir>

[高级] 控制磁盘上缓存数据的位置，这些数据会在 CLI 的多次运行之间保持，例如已下载的 QL 包和已编译的查询计划。如果未显式设置，则默认使用用户主目录下名为 .codeql 的目录；如该目录不存在，则会自动创建。

自 v2.15.2 起可用。