Upgrade phpstan + fix issues

Author: AydinHassan

.github/workflows/test.yml

@@ -27,7 +27,7 @@ jobs:
           echo "::add-matcher::${{ runner.tool_cache }}/php.json"
           echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
 
-      - name: Install dependencies
+      - name: Install cdependencies
         run: composer update --no-interaction --no-progress
 
       - name: Tests

composer.json

@@ -16,7 +16,7 @@
     "require-dev": {
         "phpunit/phpunit": "^11.5",
         "squizlabs/php_codesniffer": "^3.2",
-        "phpstan/phpstan": "^1.2.0"
+        "phpstan/phpstan": "^2.1"
     },
     "require": {
         "php" : ">=8.2",

phpstan.neon

@@ -1,2 +0,0 @@
-parameters:
-    checkMissingIterableValueType: false

src/Builder/CliMenuBuilder.php

@@ -32,66 +32,38 @@
  */
 class CliMenuBuilder
 {
-    /**
-     * @var CliMenu
-     */
-    private $menu;
+    private CliMenu $menu;
 
-    /**
-     * @var string
-     */
-    private $goBackButtonText = 'Go Back';
+    private string $goBackButtonText = 'Go Back';
 
-    /**
-     * @var string
-     */
-    private $exitButtonText = 'Exit';
+    private string $exitButtonText = 'Exit';
 
-    /**
-     * @var MenuStyle
-     */
-    private $style;
+    private MenuStyle $style;
 
-    /**
-     * @var Terminal
-     */
-    private $terminal;
+    private Terminal $terminal;
 
-    /**
-     * @var bool
-     */
-    private $disableDefaultItems = false;
+    private bool $disableDefaultItems = false;
 
-    /**
-     * @var bool
-     */
-    private $disabled = false;
+    private bool $disabled = false;
 
     /**
      * Whether or not to auto create keyboard shortcuts for items
      * when they contain square brackets. Eg: [M]y item
-     *
-     * @var bool
      */
-    private $autoShortcuts = false;
+    private bool $autoShortcuts = false;
 
     /**
      * Regex to auto match for shortcuts defaults to looking
      * for a single character encased in square brackets
-     *
-     * @var string
      */
-    private $autoShortcutsRegex = '/\[(.)\]/';
+    private string $autoShortcutsRegex = '/\[(.)\]/';
 
     /**
-     * @var array
+     * @var list<array{class: class-string<MenuItemInterface>, style: ItemStyle}>
      */
-    private $extraItemStyles = [];
+    private array $extraItemStyles = [];
 
-    /**
-     * @var bool
-     */
-    private $subMenu = false;
+    private bool $subMenu = false;
 
     public function __construct(?Terminal $terminal = null)
     {
@@ -135,6 +107,9 @@ public function addItem(
         return $this;
     }
 
+    /**
+     * @param list<array{0: string, 1: callable}> $items
+     */
     public function addItems(array $items) : self
     {
         foreach ($items as $item) {
@@ -155,6 +130,9 @@ public function addCheckboxItem(
         return $this;
     }
 
+    /**
+     * @param list<array{0: string, 1: callable}> $items
+     */
     public function addCheckboxItems(array $items): self
     {
         foreach ($items as $item) {
@@ -175,6 +153,9 @@ public function addRadioItem(
         return $this;
     }
 
+    /**
+     * @param list<array{0: string, 1: callable}> $items
+     */
     public function addRadioItems(array $items): self
     {
         foreach ($items as $item) {
@@ -504,6 +485,9 @@ public function getTerminal() : Terminal
         return $this->terminal;
     }
 
+    /**
+     * @return list<MenuItemInterface>
+     */
     private function getDefaultItems() : array
     {
         $actions = [];
@@ -532,6 +516,9 @@ public function displayExtra() : self
         return $this;
     }
 
+    /**
+     * @param array<MenuItemInterface> $items
+     */
     private function itemsHaveExtra(array $items) : bool
     {
         return !empty(array_filter($items, function (MenuItemInterface $item) {
@@ -647,6 +634,9 @@ public function modifyStyle(string $styleClass, callable $itemCallable) : self
         return $this;
     }
 
+    /**
+     * @param class-string<MenuItemInterface> $itemClass
+     */
     public function registerItemStyle(string $itemClass, ItemStyle $itemStyle) : self
     {
         $this->menu->getStyleLocator()

src/Builder/SplitItemBuilder.php

@@ -12,6 +12,7 @@
 use PhpSchool\CliMenu\MenuItem\SelectableItem;
 use PhpSchool\CliMenu\MenuItem\SplitItem;
 use PhpSchool\CliMenu\MenuItem\StaticItem;
+use PhpSchool\CliMenu\MenuStyle;
 use PhpSchool\CliMenu\Style\ItemStyle;
 use function \PhpSchool\CliMenu\Util\each;
 
@@ -20,36 +21,26 @@
  */
 class SplitItemBuilder
 {
-    /**
-     * @var CliMenu
-     */
-    private $menu;
+    private CliMenu $menu;
 
-    /**
-     * @var SplitItem
-     */
-    private $splitItem;
+    private SplitItem $splitItem;
 
     /**
-     * Whether or not to auto create keyboard shortcuts for items
+     * Whether to auto create keyboard shortcuts for items
      * when they contain square brackets. Eg: [M]y item
-     *
-     * @var bool
      */
-    private $autoShortcuts = false;
+    private bool $autoShortcuts = false;
 
     /**
      * Regex to auto match for shortcuts defaults to looking
      * for a single character encased in square brackets
-     *
-     * @var string
      */
-    private $autoShortcutsRegex = '/\[(.)\]/';
+    private string $autoShortcutsRegex = '/\[(.)\]/';
 
     /**
-     * @var array
+     * @var list<array{class: class-string<MenuItemInterface>, style: ItemStyle}>
      */
-    private $extraItemStyles = [];
+    private array $extraItemStyles = [];
 
     public function __construct(CliMenu $menu)
     {
@@ -155,6 +146,9 @@ public function enableAutoShortcuts(?string $regex = null) : self
         return $this;
     }
 
+    /**
+     * @param class-string<MenuItemInterface> $itemClass
+     */
     public function registerItemStyle(string $itemClass, ItemStyle $itemStyle) : self
     {
         $this->extraItemStyles[] = ['class' => $itemClass, 'style' => $itemStyle];

src/CliMenu.php

@@ -32,50 +32,29 @@
  */
 class CliMenu
 {
-    /**
-     * @var Terminal
-     */
-    protected $terminal;
+    protected Terminal $terminal;
 
-    /**
-     * @var MenuStyle
-     */
-    protected $style;
+    protected MenuStyle $style;
 
-    /**
-     * @var Locator
-     */
-    private $itemStyleLocator;
+    private Locator $itemStyleLocator;
 
-    /**
-     * @var ?string
-     */
-    protected $title;
+    protected string|null $title;
 
     /**
-     * @var MenuItemInterface[]
+     * @var array<int, MenuItemInterface>
      */
-    protected $items = [];
+    protected array $items = [];
 
-    /**
-     * @var int|null
-     */
-    protected $selectedItem;
+    protected int|null $selectedItem = null;
 
-    /**
-     * @var bool
-     */
-    protected $open = false;
+    protected bool $open = false;
 
-    /**
-     * @var CliMenu|null
-     */
-    protected $parent;
+    protected CliMenu|null $parent;
 
     /**
-     * @var array
+     * @var array<string, InputCharacter::*>
      */
-    protected $defaultControlMappings = [
+    protected array $defaultControlMappings = [
         '^P' => InputCharacter::UP,
         'k'  => InputCharacter::UP,
         '^K' => InputCharacter::DOWN,
@@ -87,15 +66,15 @@ class CliMenu
     ];
 
     /**
-     * @var array
+     * @var array<string, callable>
      */
-    protected $customControlMappings = [];
+    protected array $customControlMappings = [];
+
+    private Frame $currentFrame;
 
     /**
-     * @var Frame
+     * @param list<MenuItemInterface> $items
      */
-    private $currentFrame;
-
     public function __construct(
         ?string $title,
         array $items,
@@ -185,6 +164,8 @@ public function addItem(MenuItemInterface $item) : void
 
     /**
      * Add multiple Items to the menu
+     *
+     * @param list<MenuItemInterface> $items
      */
     public function addItems(array $items) : void
     {
@@ -197,6 +178,8 @@ public function addItems(array $items) : void
 
     /**
      * Set Items of the menu
+     *
+     * @param list<MenuItemInterface> $items
      */
     public function setItems(array $items) : void
     {
@@ -231,6 +214,9 @@ public function disableDefaultControlMappings() : void
 
     /**
      * Set default control mappings
+     *
+     * @param array<string, InputCharacter::*> $defaultControlMappings
+     *
      */
     public function setDefaultControlMappings(array $defaultControlMappings) : void
     {
@@ -249,13 +235,18 @@ public function addCustomControlMapping(string $input, callable $callable) : voi
         $this->customControlMappings[$input] = $callable;
     }
 
+    /**
+     * @return array<string, callable>
+     */
     public function getCustomControlMappings() : array
     {
         return $this->customControlMappings;
     }
 
     /**
      * Shorthand function to add multiple custom control mapping at once
+     *
+     * @param array<string, callable> $map
      */
     public function addCustomControlMappings(array $map) : void
     {
@@ -344,7 +335,7 @@ protected function moveSelectionVertically(string $direction) : void
                 ? $this->selectedItem--
                 : $this->selectedItem++;
 
-            if ($this->selectedItem !== null && !array_key_exists($this->selectedItem, $this->items)) {
+            if (!array_key_exists($this->selectedItem, $this->items)) {
                 $this->selectedItem  = $direction === 'UP'
                     ? (int) end($itemKeys)
                     : (int) reset($itemKeys);
@@ -544,6 +535,8 @@ protected function draw() : void
 
     /**
      * Draw a menu item
+     *
+     * @return list<string>
      */
     protected function drawMenuItem(MenuItemInterface $item, bool $selected = false) : array
     {
@@ -662,6 +655,9 @@ public function setStyle(MenuStyle $style) : void
         $this->style = $style;
     }
 
+    /**
+     * @param class-string $styleClass
+     */
     public function setItemStyle(ItemStyle $style, string $styleClass) : void
     {
         $this->itemStyleLocator->setStyle($style, $styleClass);