Adds types to stubs (#1004)

Author: nunomaduro

src/Console/stubs/component.stub

@@ -9,31 +9,26 @@ class DummyClass extends BaseComponent
 {
     /**
      * Get the root selector for the component.
-     *
-     * @return string
      */
-    public function selector()
+    public function selector(): string
     {
         return '#selector';
     }
 
     /**
      * Assert that the browser page contains the component.
-     *
-     * @param  Browser  $browser
-     * @return void
      */
-    public function assert(Browser $browser)
+    public function assert(Browser $browser): void
     {
         $browser->assertVisible($this->selector());
     }
 
     /**
      * Get the element shortcuts for the component.
      *
-     * @return array
+     * @return array<string, string>
      */
-    public function elements()
+    public function elements(): array
     {
         return [
             '@element' => '#selector',

src/Console/stubs/page.stub

@@ -9,31 +9,26 @@ class DummyClass extends Page
 {
     /**
      * Get the URL for the page.
-     *
-     * @return string
      */
-    public function url()
+    public function url(): string
     {
         return '/';
     }
 
     /**
      * Assert that the browser is on the page.
-     *
-     * @param  Browser  $browser
-     * @return void
      */
-    public function assert(Browser $browser)
+    public function assert(Browser $browser): void
     {
         $browser->assertPathIs($this->url());
     }
 
     /**
      * Get the element shortcuts for the page.
      *
-     * @return array
+     * @return array<string, string>
      */
-    public function elements()
+    public function elements(): array
     {
         return [
             '@element' => '#selector',

src/Console/stubs/test.stub

@@ -10,10 +10,8 @@ class DummyClass extends DuskTestCase
 {
     /**
      * A Dusk test example.
-     *
-     * @return void
      */
-    public function testExample()
+    public function testExample(): void
     {
         $this->browse(function (Browser $browser) {
             $browser->visit('/')

stubs/DuskTestCase.stub

@@ -2,6 +2,7 @@
 
 namespace Tests;
 
+use Illuminate\Support\Collection;
 use Facebook\WebDriver\Chrome\ChromeOptions;
 use Facebook\WebDriver\Remote\DesiredCapabilities;
 use Facebook\WebDriver\Remote\RemoteWebDriver;
@@ -15,9 +16,8 @@ abstract class DuskTestCase extends BaseTestCase
      * Prepare for Dusk test execution.
      *
      * @beforeClass
-     * @return void
      */
-    public static function prepare()
+    public static function prepare(): void
     {
         if (! static::runningInSail()) {
             static::startChromeDriver();
@@ -26,14 +26,12 @@ abstract class DuskTestCase extends BaseTestCase
 
     /**
      * Create the RemoteWebDriver instance.
-     *
-     * @return \Facebook\WebDriver\Remote\RemoteWebDriver
      */
-    protected function driver()
+    protected function driver(): RemoteWebDriver
     {
         $options = (new ChromeOptions)->addArguments(collect([
             $this->shouldStartMaximized() ? '--start-maximized' : '--window-size=1920,1080',
-        ])->unless($this->hasHeadlessDisabled(), function ($items) {
+        ])->unless($this->hasHeadlessDisabled(), function (Collection $items) {
             return $items->merge([
                 '--disable-gpu',
                 '--headless',
@@ -50,21 +48,17 @@ abstract class DuskTestCase extends BaseTestCase
 
     /**
      * Determine whether the Dusk command has disabled headless mode.
-     *
-     * @return bool
      */
-    protected function hasHeadlessDisabled()
+    protected function hasHeadlessDisabled(): bool
     {
         return isset($_SERVER['DUSK_HEADLESS_DISABLED']) ||
                isset($_ENV['DUSK_HEADLESS_DISABLED']);
     }
 
     /**
      * Determine if the browser window should start maximized.
-     *
-     * @return bool
      */
-    protected function shouldStartMaximized()
+    protected function shouldStartMaximized(): bool
     {
         return isset($_SERVER['DUSK_START_MAXIMIZED']) ||
                isset($_ENV['DUSK_START_MAXIMIZED']);

stubs/ExampleTest.stub

@@ -10,10 +10,8 @@ class ExampleTest extends DuskTestCase
 {
     /**
      * A basic browser test example.
-     *
-     * @return void
      */
-    public function testBasicExample()
+    public function testBasicExample(): void
     {
         $this->browse(function (Browser $browser) {
             $browser->visit('/')

stubs/HomePage.stub

@@ -8,31 +8,26 @@ class HomePage extends Page
 {
     /**
      * Get the URL for the page.
-     *
-     * @return string
      */
-    public function url()
+    public function url(): string
     {
         return '/';
     }
 
     /**
      * Assert that the browser is on the page.
-     *
-     * @param  \Laravel\Dusk\Browser  $browser
-     * @return void
      */
-    public function assert(Browser $browser)
+    public function assert(Browser $browser): void
     {
         //
     }
 
     /**
      * Get the element shortcuts for the page.
      *
-     * @return array
+     * @return array<string, string>
      */
-    public function elements()
+    public function elements(): array
     {
         return [
             '@element' => '#selector',

stubs/Page.stub

@@ -9,9 +9,9 @@ abstract class Page extends BasePage
     /**
      * Get the global element shortcuts for the site.
      *
-     * @return array
+     * @return array<string, string>
      */
-    public static function siteElements()
+    public static function siteElements(): array
     {
         return [
             '@element' => '#selector',