Restore Psalm

Author: lruozzi9

.github/workflows/build.yml

@@ -137,6 +137,9 @@ jobs:
             -   name: Run PHPStan
                 run: vendor/bin/phpstan analyse
 
+            -   name: Run Psalm
+                run: vendor/bin/psalm
+
             -   name: Run PHPSpec
                 run: vendor/bin/phpspec run --ansi -f progress --no-interaction
 

composer.json

@@ -67,7 +67,8 @@
         "symfony/dotenv": "^6.4 || ^7.3",
         "symfony/flex": "^2.2.2",
         "symfony/intl": "^6.4 || ^7.3",
-        "symfony/web-profiler-bundle": "^6.4 || ^7.3"
+        "symfony/web-profiler-bundle": "^6.4 || ^7.3",
+        "vimeo/psalm": "^6.13"
     },
     "conflict": {
         "symfony/framework-bundle": "6.2.8"

psalm.xml

@@ -0,0 +1,38 @@
+<?xml version="1.0"?>
+<psalm
+    errorLevel="1"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns="https://getpsalm.org/schema/config"
+    xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+>
+    <projectFiles>
+        <directory name="src" />
+        <ignoreFiles>
+            <directory name="vendor" />
+        </ignoreFiles>
+    </projectFiles>
+
+    <issueHandlers>
+        <MissingOverrideAttribute>
+            <errorLevel type="suppress">
+                <directory name="src"/>
+                <directory name="src"/>
+            </errorLevel>
+        </MissingOverrideAttribute>
+        <PossiblyUnusedMethod>
+            <errorLevel type="suppress">
+                <directory name="src"/>
+            </errorLevel>
+        </PossiblyUnusedMethod>
+        <UnusedClass>
+            <errorLevel type="suppress">
+                <directory name="src"/>
+            </errorLevel>
+        </UnusedClass>
+        <PossiblyUnusedProperty>
+            <errorLevel type="suppress">
+                <file name="src/Twig/Component/AddNotificationComponent.php"/>
+            </errorLevel>
+        </PossiblyUnusedProperty>
+    </issueHandlers>
+</psalm>

src/Command/AlertCommand.php

@@ -78,6 +78,7 @@ private function sendEmail(
         ProductVariantInterface $productVariant,
         ChannelInterface $channel,
     ): void {
+        /** @psalm-suppress DeprecatedMethod */
         $this->sender->send(
             'webgriffe_back_in_stock_notification_alert',
             [$subscription->getEmail()],

src/Controller/SubscriptionController.php

@@ -10,6 +10,9 @@
 use Symfony\Contracts\Translation\TranslatorInterface;
 use Webgriffe\SyliusBackInStockNotificationPlugin\Repository\SubscriptionRepositoryInterface;
 
+/**
+ * @psalm-suppress PropertyNotSetInConstructor
+ */
 final class SubscriptionController extends AbstractController
 {
     public function __construct(

src/Entity/Subscription.php

@@ -9,6 +9,9 @@
 use Sylius\Component\Customer\Model\CustomerInterface;
 use Sylius\Component\Resource\Model\TimestampableTrait;
 
+/**
+ * @psalm-suppress ClassMustBeFinal
+ */
 class Subscription implements SubscriptionInterface
 {
     use TimestampableTrait;

src/Factory/SubscriptionFactory.php

@@ -12,6 +12,9 @@
 
 final readonly class SubscriptionFactory implements SubscriptionFactoryInterface
 {
+    /**
+     * @param class-string $className
+     */
     public function __construct(private string $className)
     {
     }
@@ -28,6 +31,7 @@ public function createWithData(
         string $localeCode,
         ?CustomerInterface $customer = null,
     ): SubscriptionInterface {
+        /** @psalm-suppress MixedMethodCall */
         $subscription = new $this->className();
         Assert::isInstanceOf($subscription, SubscriptionInterface::class);
 

src/Factory/SubscriptionFactoryInterface.php

@@ -10,6 +10,9 @@
 use Sylius\Resource\Factory\FactoryInterface;
 use Webgriffe\SyliusBackInStockNotificationPlugin\Entity\SubscriptionInterface;
 
+/**
+ * @extends FactoryInterface<SubscriptionInterface>
+ */
 interface SubscriptionFactoryInterface extends FactoryInterface
 {
     public function createWithData(

src/Processor/SubscriptionProcessor.php

@@ -41,6 +41,7 @@ public function process(
         );
 
         $this->backInStockNotificationRepository->add($subscription);
+        /** @psalm-suppress DeprecatedMethod */
         $this->sender->send(
             'webgriffe_back_in_stock_notification_success_subscription',
             [$subscription->getEmail()],

src/Processor/SubscriptionProcessorInterface.php

@@ -10,5 +10,8 @@
 
 interface SubscriptionProcessorInterface
 {
+    /**
+     * @psalm-suppress PossiblyUnusedReturnValue
+     */
     public function process(ProductVariantInterface $productVariant, string $email, ?CustomerInterface $customer = null): SubscriptionInterface;
 }