chore: modernize and update types

ramsey · ramsey · commit e0797cdfbc4d · 2025-03-06T20:55:54.000-06:00
diff --git a/src/LibraryStarterKit/Answers.php b/src/LibraryStarterKit/Answers.php
@@ -60,13 +60,10 @@ final class Answers
     public bool $skipPrompts = false;
     public ?string $vendorName = null;
 
-    private string $saveToPath;
-    private Filesystem $filesystem;
-
-    public function __construct(string $saveToPath, Filesystem $filesystem)
-    {
-        $this->saveToPath = $saveToPath;
-        $this->filesystem = $filesystem;
+    public function __construct(
+        private readonly string $saveToPath,
+        private readonly Filesystem $filesystem,
+    ) {
         $this->loadFile();
     }
 
diff --git a/src/LibraryStarterKit/Console/InstallQuestions.php b/src/LibraryStarterKit/Console/InstallQuestions.php
@@ -44,7 +44,7 @@
 class InstallQuestions
 {
     /**
-     * @return array<StarterKitQuestion & SymfonyQuestion>
+     * @return list<StarterKitQuestion & SymfonyQuestion>
      */
     public function getQuestions(Answers $answers): array
     {
diff --git a/src/LibraryStarterKit/Console/Question/CodeOfConduct.php b/src/LibraryStarterKit/Console/Question/CodeOfConduct.php
@@ -63,6 +63,9 @@ public function __construct(Answers $answers)
         $this->answers = $answers;
     }
 
+    /**
+     * @return callable(string | null): string
+     */
     public function getNormalizer(): callable
     {
         $choiceMap = array_combine(self::CHOICES, self::CHOICE_IDENTIFIER_MAP);
@@ -76,6 +79,9 @@ public function getNormalizer(): callable
         };
     }
 
+    /**
+     * @return callable(string | null): (string | null)
+     */
     public function getValidator(): callable
     {
         return function (?string $value): ?string {
diff --git a/src/LibraryStarterKit/Console/Question/CodeOfConductCommittee.php b/src/LibraryStarterKit/Console/Question/CodeOfConductCommittee.php
@@ -36,6 +36,9 @@ public function __construct(Answers $answers)
         $this->answers = $answers;
     }
 
+    /**
+     * @return callable(string | null): (string | null)
+     */
     public function getValidator(): callable
     {
         return fn (?string $data): ?string => $data;
diff --git a/src/LibraryStarterKit/Console/Question/CopyrightYear.php b/src/LibraryStarterKit/Console/Question/CopyrightYear.php
@@ -45,6 +45,9 @@ public function getDefault(): float | bool | int | string | null
         return $this->getAnswers()->copyrightYear ?? date('Y');
     }
 
+    /**
+     * @return callable(string | null): string
+     */
     public function getValidator(): callable
     {
         return function (?string $data): string {
diff --git a/src/LibraryStarterKit/Console/Question/EmailValidatorTool.php b/src/LibraryStarterKit/Console/Question/EmailValidatorTool.php
@@ -25,6 +25,9 @@ trait EmailValidatorTool
 {
     private bool $isOptional = true;
 
+    /**
+     * @return callable(string | null): (string | null)
+     */
     public function getValidator(): callable
     {
         return function (?string $data): ?string {
diff --git a/src/LibraryStarterKit/Console/Question/License.php b/src/LibraryStarterKit/Console/Question/License.php
@@ -79,6 +79,9 @@ public function __construct(Answers $answers)
         $this->answers = $answers;
     }
 
+    /**
+     * @return callable(string | null): string
+     */
     public function getNormalizer(): callable
     {
         $choiceMap = array_combine(self::CHOICES, self::CHOICE_IDENTIFIER_MAP);
@@ -92,6 +95,9 @@ public function getNormalizer(): callable
         };
     }
 
+    /**
+     * @return callable(string | null): string
+     */
     public function getValidator(): callable
     {
         return function (?string $value): string {
diff --git a/src/LibraryStarterKit/Console/Question/PackageDescription.php b/src/LibraryStarterKit/Console/Question/PackageDescription.php
@@ -36,6 +36,9 @@ public function __construct(Answers $answers)
         $this->answers = $answers;
     }
 
+    /**
+     * @return callable(string | null): (string | null)
+     */
     public function getValidator(): callable
     {
         return fn (?string $data): ?string => $data;
diff --git a/src/LibraryStarterKit/Console/Question/PackageKeywords.php b/src/LibraryStarterKit/Console/Question/PackageKeywords.php
@@ -43,6 +43,9 @@ public function __construct(Answers $answers)
         $this->answers = $answers;
     }
 
+    /**
+     * @return callable(string | null): list<string>
+     */
     public function getNormalizer(): callable
     {
         return function (?string $answer): array {
diff --git a/src/LibraryStarterKit/Console/Question/UrlValidatorTool.php b/src/LibraryStarterKit/Console/Question/UrlValidatorTool.php
@@ -14,7 +14,7 @@
 use Ramsey\Dev\LibraryStarterKit\Exception\InvalidConsoleInput;
 
 use function filter_var;
-use function strpos;
+use function str_starts_with;
 use function trim;
 
 use const FILTER_VALIDATE_URL;
@@ -26,6 +26,9 @@ trait UrlValidatorTool
 {
     private bool $isOptional = true;
 
+    /**
+     * @return callable(string | null): (string | null)
+     */
     public function getValidator(): callable
     {
         return function (?string $data): ?string {
@@ -35,7 +38,7 @@ public function getValidator(): callable
 
             if (
                 filter_var((string) $data, FILTER_VALIDATE_URL)
-                && strpos((string) $data, 'http') === 0
+                && str_starts_with((string) $data, 'http')
             ) {
                 return $data;
             }
diff --git a/src/LibraryStarterKit/Project.php b/src/LibraryStarterKit/Project.php
@@ -13,13 +13,10 @@
 
 class Project
 {
-    private string $name;
-    private string $path;
-
-    public function __construct(string $name, string $path)
-    {
-        $this->name = $name;
-        $this->path = $path;
+    public function __construct(
+        private readonly string $name,
+        private readonly string $path,
+    ) {
     }
 
     public function getName(): string
diff --git a/src/LibraryStarterKit/Setup.php b/src/LibraryStarterKit/Setup.php
@@ -27,29 +27,16 @@
 
 class Setup
 {
-    private Event $event;
-    private Filesystem $filesystem;
-    private Finder $finder;
-    private Project $project;
-
-    /** @phpstan-var OutputInterface::VERBOSITY_* */
-    private int $verbosity;
-
     /**
      * @phpstan-param OutputInterface::VERBOSITY_* $verbosity
      */
     public function __construct(
-        Project $project,
-        Event $event,
-        Filesystem $filesystem,
-        Finder $finder,
-        int $verbosity,
+        private readonly Project $project,
+        private readonly Event $event,
+        private readonly Filesystem $filesystem,
+        private readonly Finder $finder,
+        private readonly int $verbosity,
     ) {
-        $this->project = $project;
-        $this->event = $event;
-        $this->filesystem = $filesystem;
-        $this->finder = $finder;
-        $this->verbosity = $verbosity;
     }
 
     /**
diff --git a/src/LibraryStarterKit/Task/Build.php b/src/LibraryStarterKit/Task/Build.php
@@ -36,18 +36,11 @@
  */
 class Build
 {
-    private Answers $answers;
-    private Setup $setup;
-    private SymfonyStyle $console;
-
     public function __construct(
-        Setup $setup,
-        SymfonyStyle $console,
-        Answers $answers,
+        private readonly Setup $setup,
+        private readonly SymfonyStyle $console,
+        private readonly Answers $answers,
     ) {
-        $this->setup = $setup;
-        $this->console = $console;
-        $this->answers = $answers;
     }
 
     public function getAnswers(): Answers
diff --git a/src/LibraryStarterKit/Task/Builder.php b/src/LibraryStarterKit/Task/Builder.php
@@ -20,11 +20,8 @@
  */
 abstract class Builder
 {
-    private Build $buildTask;
-
-    public function __construct(Build $buildTask)
+    public function __construct(private readonly Build $buildTask)
     {
-        $this->buildTask = $buildTask;
     }
 
     /**
diff --git a/src/LibraryStarterKit/Task/Builder/InstallDependencies.php b/src/LibraryStarterKit/Task/Builder/InstallDependencies.php
@@ -22,7 +22,7 @@ public function build(): void
     {
         $this->getConsole()->section('Installing dependencies');
 
-        // Remove lockfiles and vendor directories to start fresh.
+        // Remove lock files and vendor directories to start fresh.
         $this->getEnvironment()->getFilesystem()->remove([
             $this->getEnvironment()->path('composer.lock'),
             $this->getEnvironment()->path('vendor'),
diff --git a/src/LibraryStarterKit/Task/Builder/UpdateComposerJson.php b/src/LibraryStarterKit/Task/Builder/UpdateComposerJson.php
@@ -14,11 +14,13 @@
 use Ramsey\Dev\LibraryStarterKit\Task\Builder;
 use RuntimeException;
 
+use function array_filter;
 use function in_array;
 use function json_decode;
 use function json_encode;
 use function trim;
 
+use const ARRAY_FILTER_USE_KEY;
 use const JSON_PRETTY_PRINT;
 use const JSON_UNESCAPED_SLASHES;
 use const JSON_UNESCAPED_UNICODE;
@@ -92,15 +94,7 @@ public function build(): void
      */
     private function filterPropertiesByAllowlist(array $data, array $allowlist): array
     {
-        $filtered = [];
-
-        foreach ($data as $property => $value) {
-            if (in_array($property, $allowlist)) {
-                $filtered[$property] = $value;
-            }
-        }
-
-        return $filtered;
+        return array_filter($data, fn ($property) => in_array($property, $allowlist), ARRAY_FILTER_USE_KEY);
     }
 
     private function getComposerContents(): string
diff --git a/src/LibraryStarterKit/Task/Builder/UpdateLicense.php b/src/LibraryStarterKit/Task/Builder/UpdateLicense.php
@@ -13,7 +13,7 @@
 
 use Ramsey\Dev\LibraryStarterKit\Task\Builder;
 
-use function strpos;
+use function str_starts_with;
 
 use const DIRECTORY_SEPARATOR;
 
@@ -81,7 +81,7 @@ private function handleLicenseFile(string $license): void
             $licenseContents,
         );
 
-        if (strpos($license, 'LGPL-3.0') === 0) {
+        if (str_starts_with($license, 'LGPL-3.0')) {
             $this->includeGplWithLesserGpl();
         }
     }
diff --git a/src/LibraryStarterKit/Wizard.php b/src/LibraryStarterKit/Wizard.php
@@ -42,17 +42,14 @@ class Wizard extends Command
 
     public static ?Application $application = null;
 
-    private Setup $setup;
-    private StyleFactory $styleFactory;
     private Answers $answers;
 
-    public function __construct(Setup $setup, ?StyleFactory $styleFactory = null)
-    {
+    public function __construct(
+        private readonly Setup $setup,
+        private readonly StyleFactory $styleFactory = new StyleFactory(),
+    ) {
         parent::__construct('starter-kit');
 
-        $this->setup = $setup;
-        $this->styleFactory = $styleFactory ?? new StyleFactory();
-
         $this->answers = new Answers(
             $this->getAnswersFile(),
             $this->setup->getFilesystem(),

Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,7 @@`
`44`	`44`	`class InstallQuestions`
`45`	`45`	`{`
`46`	`46`	`/**`
`47`		`- * @return array<StarterKitQuestion & SymfonyQuestion>`
	`47`	`+ * @return list<StarterKitQuestion & SymfonyQuestion>`
`48`	`48`	`*/`
`49`	`49`	`public function getQuestions(Answers $answers): array`
`50`	`50`	`{`
Original file line number	Diff line number	Diff line change
`@@ -63,6 +63,9 @@ public function __construct(Answers $answers)`
`63`	`63`	`$this->answers = $answers;`
`64`	`64`	`}`
`65`	`65`
	`66`	`+ /**`
	`67`	`+ * @return callable(string \| null): string`
	`68`	`+ */`
`66`	`69`	`public function getNormalizer(): callable`
`67`	`70`	`{`
`68`	`71`	`$choiceMap = array_combine(self::CHOICES, self::CHOICE_IDENTIFIER_MAP);`
`@@ -76,6 +79,9 @@ public function getNormalizer(): callable`
`76`	`79`	`};`
`77`	`80`	`}`
`78`	`81`
	`82`	`+ /**`
	`83`	`+ * @return callable(string \| null): (string \| null)`
	`84`	`+ */`
`79`	`85`	`public function getValidator(): callable`
`80`	`86`	`{`
`81`	`87`	`return function (?string $value): ?string {`
Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,9 @@ public function __construct(Answers $answers)`
`36`	`36`	`$this->answers = $answers;`
`37`	`37`	`}`
`38`	`38`
	`39`	`+ /**`
	`40`	`+ * @return callable(string \| null): (string \| null)`
	`41`	`+ */`
`39`	`42`	`public function getValidator(): callable`
`40`	`43`	`{`
`41`	`44`	`return fn (?string $data): ?string => $data;`
Original file line number	Diff line number	Diff line change
`@@ -45,6 +45,9 @@ public function getDefault(): float \| bool \| int \| string \| null`
`45`	`45`	`return $this->getAnswers()->copyrightYear ?? date('Y');`
`46`	`46`	`}`
`47`	`47`
	`48`	`+ /**`
	`49`	`+ * @return callable(string \| null): string`
	`50`	`+ */`
`48`	`51`	`public function getValidator(): callable`
`49`	`52`	`{`
`50`	`53`	`return function (?string $data): string {`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,9 @@ trait EmailValidatorTool`
`25`	`25`	`{`
`26`	`26`	`private bool $isOptional = true;`
`27`	`27`
	`28`	`+ /**`
	`29`	`+ * @return callable(string \| null): (string \| null)`
	`30`	`+ */`
`28`	`31`	`public function getValidator(): callable`
`29`	`32`	`{`
`30`	`33`	`return function (?string $data): ?string {`
Original file line number	Diff line number	Diff line change
`@@ -79,6 +79,9 @@ public function __construct(Answers $answers)`
`79`	`79`	`$this->answers = $answers;`
`80`	`80`	`}`
`81`	`81`
	`82`	`+ /**`
	`83`	`+ * @return callable(string \| null): string`
	`84`	`+ */`
`82`	`85`	`public function getNormalizer(): callable`
`83`	`86`	`{`
`84`	`87`	`$choiceMap = array_combine(self::CHOICES, self::CHOICE_IDENTIFIER_MAP);`
`@@ -92,6 +95,9 @@ public function getNormalizer(): callable`
`92`	`95`	`};`
`93`	`96`	`}`
`94`	`97`
	`98`	`+ /**`
	`99`	`+ * @return callable(string \| null): string`
	`100`	`+ */`
`95`	`101`	`public function getValidator(): callable`
`96`	`102`	`{`
`97`	`103`	`return function (?string $value): string {`
Original file line number	Diff line number	Diff line change
`@@ -43,6 +43,9 @@ public function __construct(Answers $answers)`
`43`	`43`	`$this->answers = $answers;`
`44`	`44`	`}`
`45`	`45`
	`46`	`+ /**`
	`47`	`+ * @return callable(string \| null): list<string>`
	`48`	`+ */`
`46`	`49`	`public function getNormalizer(): callable`
`47`	`50`	`{`
`48`	`51`	`return function (?string $answer): array {`