Merge pull request #29 from webfactor/issue-26

Open files in IDE

Author: tswonke

README.md

@@ -215,7 +215,22 @@ With `{--git}` option all generated files will be added to git automatically. In
 
 ## Open files in IDE
 
-With `{--ide=}` option you can define your preferred IDE to open all automatically generated files. The keys in the `ides`-Array of the config file are possible values for the command option. You can add other IDE-Opener classes, they have to implement `Webfactor\Laravel\Generators\Contracts\OpenInIdeInterface`. This package comes with implementations for PhpStorm (`pstorm`), Sublime (`sublime`) and VS Code (`vscode`). 
+If specified we will automatically open all generated files in the IDE of your choice.  
+There are three options to use this feature (applied in this order):
+* `{--ide=}` command option
+* __.env__ variable `APP_EDITOR`
+* config value `config('app.editor')`
+
+The keys in the `ides`-Array of the config file are possible values for the command option.
+Per default we provide:
+* `phpstorm`: will open all files with `pstorm` CLI helper of PhpStorm
+* `pstorm`: will open all files with `pstorm` CLI helper of PhpStorm
+* `sublime`: will open all files with `subl` CLI helper of Sublime
+* `subl`: will open all files with `subl` CLI helper of Sublime
+* `vscode`: will open all files with `code` CLI helper of VSCode
+* `code`: will open all files with `code` CLI helper of VSCode
+
+You can add other IDE-Opener classes. They have to implement `Webfactor\Laravel\Generators\Contracts\OpenInIdeInterface`. 
 
 In your service class you have to add the generated file to a stack (see "Add files to git" section)
 

config/generators.php

@@ -22,28 +22,31 @@
      * is used. Have to implement Webfactor\Laravel\Generators\Contracts\OpenIdeInterface.
      */
     'ides'     => [
-        'pstorm' => Webfactor\Laravel\Generators\Recipes\PhpStormOpener::class,
-        'sublime' => Webfactor\Laravel\Generators\Recipes\SublimeOpener::class,
-        'vscode' => Webfactor\Laravel\Generators\Recipes\VSCodeOpener::class,
+        'phpstorm' => Webfactor\Laravel\Generators\Recipes\PhpStormOpener::class,
+        'pstorm'   => Webfactor\Laravel\Generators\Recipes\PhpStormOpener::class,
+        'sublime'  => Webfactor\Laravel\Generators\Recipes\SublimeOpener::class,
+        'subl'     => Webfactor\Laravel\Generators\Recipes\SublimeOpener::class,
+        'vscode'   => Webfactor\Laravel\Generators\Recipes\VSCodeOpener::class,
+        'code'     => Webfactor\Laravel\Generators\Recipes\VSCodeOpener::class,
     ],
 
     'naming' => [
-        'migration' => Webfactor\Laravel\Generators\Schemas\Naming\Migration::class,
-        'languageFile' => Webfactor\Laravel\Generators\Schemas\Naming\LanguageFile::class,
-        'crudModel' => Webfactor\Laravel\Generators\Schemas\Naming\CrudModel::class,
-        'crudRequest' => Webfactor\Laravel\Generators\Schemas\Naming\CrudRequest::class,
+        'migration'      => Webfactor\Laravel\Generators\Schemas\Naming\Migration::class,
+        'languageFile'   => Webfactor\Laravel\Generators\Schemas\Naming\LanguageFile::class,
+        'crudModel'      => Webfactor\Laravel\Generators\Schemas\Naming\CrudModel::class,
+        'crudRequest'    => Webfactor\Laravel\Generators\Schemas\Naming\CrudRequest::class,
         'crudController' => Webfactor\Laravel\Generators\Schemas\Naming\CrudController::class,
-        'routeFile' => Webfactor\Laravel\Generators\Schemas\Naming\RouteFile::class,
-        'factory' => Webfactor\Laravel\Generators\Schemas\Naming\Factory::class,
-        'seeder' => Webfactor\Laravel\Generators\Schemas\Naming\Seeder::class,
-        'sidebar' => Webfactor\Laravel\Generators\Schemas\Naming\Sidebar::class,
+        'routeFile'      => Webfactor\Laravel\Generators\Schemas\Naming\RouteFile::class,
+        'factory'        => Webfactor\Laravel\Generators\Schemas\Naming\Factory::class,
+        'seeder'         => Webfactor\Laravel\Generators\Schemas\Naming\Seeder::class,
+        'sidebar'        => Webfactor\Laravel\Generators\Schemas\Naming\Sidebar::class,
     ],
 
     'fieldTypes' => [
-        'date' => \Webfactor\Laravel\Generators\Schemas\FieldTypes\DateType::class,
-        'number' => \Webfactor\Laravel\Generators\Schemas\FieldTypes\NumberType::class,
+        'date'       => \Webfactor\Laravel\Generators\Schemas\FieldTypes\DateType::class,
+        'number'     => \Webfactor\Laravel\Generators\Schemas\FieldTypes\NumberType::class,
         'summernote' => \Webfactor\Laravel\Generators\Schemas\FieldTypes\SummernoteType::class,
-        'string' => \Webfactor\Laravel\Generators\Schemas\FieldTypes\StringType::class,
-        'text' => \Webfactor\Laravel\Generators\Schemas\FieldTypes\TextType::class,
-    ]
+        'string'     => \Webfactor\Laravel\Generators\Schemas\FieldTypes\StringType::class,
+        'text'       => \Webfactor\Laravel\Generators\Schemas\FieldTypes\TextType::class,
+    ],
 ];

src/Services/OpenIdeService.php

@@ -9,12 +9,27 @@ class OpenIdeService extends ServiceAbstract implements ServiceInterface
 {
     public function call()
     {
-        if (!$ide = $this->command->option('ide')) {
-            return;
+        if ($ide = $this->command->option('ide')) {
+            return $this->openInIde($ide);
+        }
+
+        if ($ide = env('APP_EDITOR')) {
+            return $this->openInIde($ide);
+        }
+
+        if ($ide = config('app.editor')) {
+            return $this->openInIde($ide);
         }
+    }
 
+    protected function openInIde($ide)
+    {
         if ($ideClass = config('webfactor.generators.ides.' . $ide)) {
             (new $ideClass($this->command->filesToBeOpened))->open();
+
+            return;
         }
+
+        $this->command->error('There is no opener class for ide <comment>' . $ide . '</comment>');
     }
 }