facile-it/psalm-psr-log-plugin

Psalm plugin for psr/log (PSR-3)

0.1.2 2023-04-07 15:32 UTC

Requires

• php: ^7.2 || ^8.0
• ext-simplexml: *
• psr/log: ^1.1 || ^2.0 || ^3.0
• vimeo/psalm: ^4.7 || ^5.0

Requires (Dev)

• codeception/codeception: ^4.1
• facile-it/facile-coding-standard: ^0.5.2
• weirdan/codeception-psalm-module: ^0.13.0

MIT

• Thomas Vargiu

README

A Psalm plugin to check psr/log (PSR-3) usage.

Features

• Suppress ImplicitToStringCast psalm errors when objects with a __toString() method are used as message
• Checks that all placeholders used in a message string are in the context array

Example

This plugin checks for missing context keys for placeholders:

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

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

Usage

Include the plugin in your psalm.xml config file.

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

Required keys

if you want to always require keys in context, you can configure the plugin with the requiredKey:

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

Ignored keys

if you want to ignore requirement for some key in context, you can configure the plugin with the ignoredKey.

This is useful when you have your logger that automatically injects it.

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