README

一个用于检查 psr/log (PSR-3) 用法的 Psalm 插件。

特性

当使用具有 __toString() 方法的对象作为消息时，抑制 ImplicitToStringCast 的 Psalm 错误
检查消息字符串中使用的所有占位符是否在上下文数组中

示例

此插件检查占位符缺失的上下文键

/** @var Psr\Log\LoggerInterface $logger */

$logger->info('User {username} logged in at {datetime}', [
    'username' => 'user-username',
]);

用法

将插件包含在您的 psalm.xml 配置文件中。

<psalm>
    <plugins>
        <pluginClass class="Facile\Psalm\PsrLogPlugin\Plugin"/>
    </plugins>
</psalm>

必需的键

如果您想始终要求上下文中的键，您可以配置插件使用 requiredKey

<psalm>
    <plugins>
        <pluginClass class="Facile\Psalm\PsrLogPlugin\Plugin">
            <requiredKey>requestId</requiredKey>
            <requiredKey>environment</requiredKey>
        </pluginClass>
    </plugins>
</psalm>

忽略的键

如果您想忽略某些键在上下文中的要求，您可以配置插件使用 ignoredKey。

这在你有自动注入的日志记录器时很有用。

<psalm>
    <plugins>
        <pluginClass class="Facile\Psalm\PsrLogPlugin\Plugin">
            <ignoredKey>requestId</ignoredKey>
        </pluginClass>
    </plugins>
</psalm>

facile-it / psalm-psr-log-plugin

维护者

详细信息

README

特性

示例

用法

必需的键

忽略的键