内容

名称

Test2::EventFacet::Info - 用于开发者关注信息的方面。

描述

此方面代表面向人类的,有助于他们理解结果或诊断故障的消息。

备注

此方面以列表形式出现,而不是单个项目。

字段

$string_or_structure = $info->{details}
$string_or_structure = $info->details()

人类可读的字符串或数据结构,这是要显示的信息。格式化程序可以随意渲染结构。这可能包含一个已祝福的对象。

如果设置了 table 属性(见下文),则渲染器可以选择显示表格而不是详细信息。

$structure = $info->{table}
$structure = $info->table()

如果 info 方面需要传达的数据可以用表格表示,则数据可以以更原始的形式放置在此属性中,以实现更好的显示。数据也必须在 details 属性中表示,以便不支持直接渲染表格的渲染器使用。

表格结构

my %table = {
    header => [ 'column 1 header', 'column 2 header', ... ], # Optional

    rows => [
        ['row 1 column 1', 'row 1, column 2', ... ],
        ['row 2 column 1', 'row 2, column 2', ... ],
        ...
    ],

    # Allow the renderer to hide empty columns when true, Optional
    collapse => $BOOL,

    # List by name or number columns that should never be collapsed
    no_collapse => \@LIST,
}
$short_string = $info->{tag}
$short_string = $info->tag()

用于对信息进行分类的简短标签。通常不超过 10 个字符,格式化程序可能会截断较长的标签。

$bool = $info->{debug}
$bool = $info->debug()

如果消息是关键的,或者解释了错误,则将其设置为 true。即使在不太详细的模式下,格式化程序也应该显示此信息。

如果为 false,则信息不被视为关键信息,并且可能不会在不太详细的模式下呈现。

$bool = $info->{important}
$bool = $info->important

这应该为非调试消息设置,这些消息仍然足够重要,即使在格式化程序处于静默模式时也能显示。格式化程序应该将这些消息发送到 STDOUT 而不是 STDERR,但即使在非详细模式下也应该显示它们。

SOURCE

Test2 的源代码库可以在 http://github.com/Test-More/test-more/ 找到。

MAINTAINERS

Chad Granum <[email protected]>

AUTHORS

Chad Granum <[email protected]>

COPYRIGHT

Copyright 2020 Chad Granum <[email protected]>.

本程序是自由软件;您可以根据与 Perl 本身相同的条款重新发布和/或修改它。

参见 https://dev.perl5.cn/licenses/