诊断添加

Note

此内容描述了 CodeQL CLI 的最新版本。有关此版本的详细信息，请参阅 https://github.com/github/codeql-cli-binaries/releases 。

若要查看早期版本中此命令可用选项的详细信息，请在终端中使用 --help 选项运行命令。

摘要

Shell

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>...

说明

[实验] [Plumbing] 添加一条诊断信息。

自 v2.12.6 起可用。

选项

主要选项

`--markdown-message=<markdownMessage>`

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

`--plaintext-message=<plaintextMessage>`

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

`--severity=<severity>`

诊断的严重性。可以是“错误”、“警告”或“通知”。

`--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>`

[高级] 将详细级别显式设置为“错误”、“警告”、“进度”、“进度+”、“进度++”、“进度+++”之一。重写 -v 和 -q。

`--logdir=<dir>`

[高级] 将详细日志写入给定目录中的一个或多个文件，其中生成的名称包括时间戳和正在运行的子命令的名称。

（若要使用可以完全控制的名称编写日志文件，请根据需要提供 --log-to-stderr 并重定向 stderr。）

`--common-caches=<dir>`

[高级] 控制磁盘上缓存数据的位置，此位置会在多次运行 CLI（例如下载的 QL 包和已编译查询计划）期间暂留。如果未明确设置，则默认为用户主目录中名为 .codeql 的目录；如果尚不存在，则会创建该目录。

自 v2.15.2 起可用。