Add type hints

Author: jasonmccreary

src/Blueprint.php

@@ -9,11 +9,11 @@
 
 class Blueprint
 {
-    private $lexers = [];
+    private array $lexers = [];
 
-    private $generators = [];
+    private array $generators = [];
 
-    public static function relativeNamespace(string $fullyQualifiedClassName)
+    public static function relativeNamespace(string $fullyQualifiedClassName): string
     {
         $namespace = config('blueprint.namespace') . '\\';
         $reference = ltrim($fullyQualifiedClassName, '\\');
@@ -73,7 +73,7 @@ public function parse($content, $strip_dashes = true)
         return Yaml::parse($content);
     }
 
-    public function analyze(array $tokens)
+    public function analyze(array $tokens): Tree
     {
         $registry = [
             'models' => [],
@@ -100,22 +100,22 @@ public function generate(Tree $tree, array $only = [], array $skip = [], $overwr
         return $components;
     }
 
-    public function dump(array $generated)
+    public function dump(array $generated): string
     {
         return Yaml::dump($generated);
     }
 
-    public function registerLexer(Lexer $lexer)
+    public function registerLexer(Lexer $lexer): void
     {
         $this->lexers[] = $lexer;
     }
 
-    public function registerGenerator(Generator $generator)
+    public function registerGenerator(Generator $generator): void
     {
         $this->generators[] = $generator;
     }
 
-    public function swapGenerator(string $concrete, Generator $generator)
+    public function swapGenerator(string $concrete, Generator $generator): void
     {
         foreach ($this->generators as $key => $registeredGenerator) {
             if (get_class($registeredGenerator) === $concrete) {

src/BlueprintServiceProvider.php

@@ -18,10 +18,8 @@ class BlueprintServiceProvider extends ServiceProvider implements DeferrableProv
 {
     /**
      * Bootstrap the application events.
-     *
-     * @return void
      */
-    public function boot()
+    public function boot(): void
     {
         if (!defined('STUBS_PATH')) {
             define('STUBS_PATH', dirname(__DIR__) . '/stubs');
@@ -42,10 +40,8 @@ public function boot()
 
     /**
      * Register the service provider.
-     *
-     * @return void
      */
-    public function register()
+    public function register(): void
     {
         $this->mergeConfigFrom(
             __DIR__ . '/../config/blueprint.php',
@@ -93,10 +89,8 @@ public function register()
 
     /**
      * Get the services provided by the provider.
-     *
-     * @return array
      */
-    public function provides()
+    public function provides(): array
     {
         return [
             'command.blueprint.build',

src/Builder.php

@@ -6,7 +6,7 @@
 
 class Builder
 {
-    public function execute(Blueprint $blueprint, Filesystem $filesystem, string $draft, string $only = '', string $skip = '', $overwriteMigrations = false)
+    public function execute(Blueprint $blueprint, Filesystem $filesystem, string $draft, string $only = '', string $skip = '', $overwriteMigrations = false): array
     {
         $cache = [];
         if ($filesystem->exists('.blueprint')) {

src/Commands/BuildCommand.php

@@ -30,11 +30,9 @@ class BuildCommand extends Command
      */
     protected $description = 'Build components from a Blueprint draft';
 
-    /** @var Filesystem */
-    protected $filesystem;
+    protected Filesystem $filesystem;
 
-    /** @var Builder */
-    private $builder;
+    private Builder $builder;
 
     public function __construct(Filesystem $filesystem, Builder $builder)
     {
@@ -44,7 +42,7 @@ public function __construct(Filesystem $filesystem, Builder $builder)
         $this->builder = $builder;
     }
 
-    public function handle()
+    public function handle(): int
     {
         $file = $this->argument('draft') ?? $this->defaultDraftFile();
 
@@ -79,17 +77,15 @@ function ($file) {
 
     /**
      * Get the console command arguments.
-     *
-     * @return array
      */
-    protected function getArguments()
+    protected function getArguments(): array
     {
         return [
             ['draft', InputArgument::OPTIONAL, 'The path to the draft file, default: draft.yaml or draft.yml', []],
         ];
     }
 
-    private function outputStyle($action)
+    private function outputStyle(string $action): string
     {
         if ($action === 'deleted') {
             return 'error';
@@ -100,7 +96,7 @@ private function outputStyle($action)
         return 'info';
     }
 
-    private function defaultDraftFile()
+    private function defaultDraftFile(): string
     {
         return file_exists('draft.yml') ? 'draft.yml' : 'draft.yaml';
     }

src/Commands/EraseCommand.php

@@ -22,8 +22,7 @@ class EraseCommand extends Command
      */
     protected $description = 'Erase components created from last Blueprint build';
 
-    /** @var Filesystem */
-    protected $filesystem;
+    protected Filesystem $filesystem;
 
     public function __construct(Filesystem $filesystem)
     {
@@ -32,7 +31,7 @@ public function __construct(Filesystem $filesystem)
         $this->filesystem = $filesystem;
     }
 
-    public function handle()
+    public function handle(): int
     {
         $contents = $this->filesystem->get('.blueprint');
 
@@ -69,7 +68,7 @@ function ($file) {
         return $this->call('blueprint:trace');
     }
 
-    private function outputStyle($action)
+    private function outputStyle(string $action): string
     {
         if ($action === 'created') {
             return 'error';

src/Commands/InitCommand.php

@@ -20,7 +20,7 @@ class InitCommand extends Command
      */
     protected $description = 'An alias for "blueprint:new" command';
 
-    public function handle()
+    public function handle(): int
     {
         return $this->call(\Blueprint\Commands\NewCommand::class);
     }

src/Commands/NewCommand.php

@@ -24,8 +24,7 @@ class NewCommand extends Command
      */
     protected $description = 'Create a draft.yaml file and load existing models';
 
-    /** @var Filesystem */
-    protected $filesystem;
+    protected Filesystem $filesystem;
 
     public function __construct(Filesystem $filesystem)
     {
@@ -34,7 +33,7 @@ public function __construct(Filesystem $filesystem)
         $this->filesystem = $filesystem;
     }
 
-    public function handle()
+    public function handle(): int
     {
         if (!$this->filesystem->exists('draft.yaml')) {
             $this->filesystem->put('draft.yaml', $this->filesystem->stub('draft.stub'));

src/Commands/PublishStubsCommand.php

@@ -20,7 +20,7 @@ class PublishStubsCommand extends Command
      */
     protected $description = 'Publish blueprint stubs';
 
-    public function handle()
+    public function handle(): int
     {
         return $this->call('vendor:publish', ['--tag' => 'blueprint-stubs']);
     }

src/Commands/TraceCommand.php

@@ -26,11 +26,9 @@ class TraceCommand extends Command
      */
     protected $description = 'Create definitions for existing models to reference in new drafts';
 
-    /** @var Filesystem */
-    protected $filesystem;
+    protected Filesystem $filesystem;
 
-    /** @var Tracer */
-    private $tracer;
+    private Tracer $tracer;
 
     public function __construct(Filesystem $filesystem, Tracer $tracer)
     {
@@ -40,7 +38,7 @@ public function __construct(Filesystem $filesystem, Tracer $tracer)
         $this->tracer = $tracer;
     }
 
-    public function handle()
+    public function handle(): int
     {
         $blueprint = resolve(Blueprint::class);
         $path = $this->option('path');

src/Concerns/HandlesImports.php

@@ -6,14 +6,14 @@
 
 trait HandlesImports
 {
-    protected $imports = [];
+    protected array $imports = [];
 
-    protected function addImport(Model $model, $class)
+    protected function addImport(Model $model, $class): void
     {
         $this->imports[$model->name()][] = $class;
     }
 
-    protected function buildImports(Model $model)
+    protected function buildImports(Model $model): string
     {
         return collect($this->imports[$model->name()] ?? [])
             ->map(fn ($class) => "use {$class};")