Remove format and broken generateJsonHelper

The JSON generate doesn't work, always generates an empty list. I looked a bit around and seems changes around 3 years ago broke it. Since there was no bug report ever about this, I conclude this feature isn't used and suggest to remove it. This also changes the config `filename` as there's no need for the extension-less version and the format is gone too. This change is backwards compatible as we just add back the `.php` in case it's missing though users are encouraged to update it.
barryvdh · Sep 10, 2020 · 4558245 · 4558245
1 parent 5db6029
commit 4558245
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 52 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,9 @@ All notable changes to this project will be documented in this file.
 ### Changed
 - Implement DeferrableProvider [\#914 / kon-shou](https://github.com/barryvdh/laravel-ide-helper/pull/914)
 
+### Removed
+- Removed format and broken generateJsonHelper [\#1053 / mfn](https://github.com/barryvdh/laravel-ide-helper/pull/1053)
+
 2020-09-07, 2.8.1
 -----------------
 ### Added

diff --git a/config/ide-helper.php b/config/ide-helper.php
@@ -7,12 +7,11 @@
     | Filename & Format
     |--------------------------------------------------------------------------
     |
-    | The default filename (without extension) and the format (php or json)
+    | The default filename
     |
     */
 
-    'filename'  => '_ide_helper',
-    'format'    => 'php',
+    'filename'  => '_ide_helper.php',
 
     /*
     |--------------------------------------------------------------------------

diff --git a/src/Console/GeneratorCommand.php b/src/Console/GeneratorCommand.php
@@ -89,15 +89,13 @@ public function handle()
         }
 
         $filename = $this->argument('filename');
-        $format = $this->option('format');
 
-        // Strip the php extension
-        if (substr($filename, -4, 4) === '.php') {
-            $filename = substr($filename, 0, -4);
+        // Add the php extension if missing
+        // This is a backwards-compatible shim and can be removed in the future
+        if (substr($filename, -4, 4) !== '.php') {
+            $filename .= '.php';
         }
 
-        $filename .= '.' . $format;
-
         if ($this->option('memory')) {
             $this->useMemoryDriver();
         }
@@ -115,7 +113,7 @@ public function handle()
         }
 
         $generator = new Generator($this->config, $this->view, $this->getOutput(), $helpers);
-        $content = $generator->generate($format);
+        $content = $generator->generate();
         $written = $this->files->put($filename, $content);
 
         if ($written !== false) {
@@ -165,11 +163,9 @@ protected function getArguments()
      */
     protected function getOptions()
     {
-        $format = $this->config->get('ide-helper.format');
         $writeMixins = $this->config->get('ide-helper.write_eloquent_model_mixins');
 
         return [
-            ['format', 'F', InputOption::VALUE_OPTIONAL, 'The format for the IDE Helper', $format],
             ['write_mixins', 'W', InputOption::VALUE_OPTIONAL, 'Write mixins to Laravel Model?', $writeMixins],
             ['helpers', 'H', InputOption::VALUE_NONE, 'Include the helper files'],
             ['memory', 'M', InputOption::VALUE_NONE, 'Use sqlite memory driver'],

diff --git a/src/Generator.php b/src/Generator.php
@@ -67,21 +67,9 @@ public function __construct(
     /**
      * Generate the helper file contents;
      *
-     * @param  string  $format  The format to generate the helper in (php/json)
      * @return string;
      */
-    public function generate($format = 'php')
-    {
-        // Check if the generator for this format exists
-        $method = 'generate' . ucfirst($format) . 'Helper';
-        if (method_exists($this, $method)) {
-            return $this->$method();
-        }
-
-        return $this->generatePhpHelper();
-    }
-
-    public function generatePhpHelper()
+    public function generate()
     {
         $app = app();
         return $this->view->make('helper')
@@ -94,33 +82,6 @@ public function generatePhpHelper()
             ->render();
     }
 
-    public function generateJsonHelper()
-    {
-        $classes = [];
-        foreach ($this->getValidAliases() as $aliases) {
-            foreach ($aliases as $alias) {
-                $functions = [];
-                foreach ($alias->getMethods() as $method) {
-                    $functions[$method->getName()] = '(' . $method->getParamsWithDefault() . ')';
-                }
-                $classes[$alias->getAlias()] = [
-                    'functions' => $functions,
-                ];
-            }
-        }
-
-        $flags = JSON_FORCE_OBJECT;
-        if (defined('JSON_PRETTY_PRINT')) {
-            $flags |= JSON_PRETTY_PRINT;
-        }
-
-        return json_encode([
-            'php' => [
-                'classes' => $classes,
-            ],
-        ], $flags);
-    }
-
     protected function detectDrivers()
     {
         $defaultUserModel = config('auth.providers.users.model', config('auth.model', 'App\User'));