Remove version

README.md

@@ -33,27 +33,42 @@ Require this package with composer using the following command:
 composer require --dev barryvdh/laravel-ide-helper
 ```
 
+> [!NOTE]  
+> If you encounter version conflicts with doctrine/dbal, please try:
+> `composer require --dev barryvdh/laravel-ide-helper --with-all-dependencies`
+ 
+This package makes use of [Laravels package auto-discovery mechanism](https://medium.com/@taylorotwell/package-auto-discovery-in-laravel-5-5-ea9e3ab20518), which means if you don't install dev dependencies in production, it also won't be loaded.
+
+If for some reason you want manually control this:
+- add the package to the `extra.laravel.dont-discover` key in `composer.json`, e.g.
+  ```json
+  "extra": {
+    "laravel": {
+      "dont-discover": [
+        "barryvdh/laravel-ide-helper"
+      ]
+    }
+  }
+  ```
+- Add the following class to the `providers` array in `config/app.php` (`bootstrap/providers.php` for Laravel 11+):
+  ```php
+  Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class,
+  ```
+  If you want to manually load it only in non-production environments, instead you can add this to your `AppServiceProvider` with the `register()` method:
+  ```php
+  public function register()
+  {
+      if ($this->app->isLocal()) {
+          $this->app->register(\Barryvdh\LaravelIdeHelper\IdeHelperServiceProvider::class);
+      }
+      // ...
+  }
+  ```
+
+> Note: Avoid caching the configuration in your development environment, it may cause issues after installing this package; respectively clear the cache beforehand via `php artisan cache:clear` if you encounter problems when running the commands
 
 ## Usage
 
-### TL;DR
-
-Run this to generate autocompletion for Facades. This creates _ide_helper.php
-
-```
-php artisan ide-helper:generate
-```
-
-Run this to add phpdocs for your models. Add -RW to Reset existing phpdocs and Write to the models directly.
-```
-php artisan ide-helper:models -RW
-```
-
-If you don't want the full _ide_helper.php file, you can run add `--write-eloquent-helper` to the model command to generate small version, which is required for the `@mixin \Eloquent` to be able to add the QueryBuilder methods.
-
-If you don't want to add all the phpdocs to your Models directly, you can use `--nowrite` to create a seperate file. The  `--write-mixin` option can be used to only add a `@mixin` to your models, but add the generated phpdocs in a seperate file. This avoids having the results marked as duplicate.
-
-
 _Check out [this Laracasts video](https://laracasts.com/series/how-to-be-awesome-in-phpstorm/episodes/15) for a quick introduction/explanation!_
 
 - `php artisan ide-helper:generate` - [PHPDoc generation for Laravel Facades ](#automatic-phpdoc-generation-for-laravel-facades)
@@ -71,6 +86,8 @@ You can now re-generate the docs yourself (for future updates)
 php artisan ide-helper:generate
 ```
 
+> Note: `bootstrap/compiled.php` has to be cleared first, so run `php artisan clear-compiled` before generating.
+
 This will generate the file `_ide_helper.php` which is expected to be additionally parsed by your IDE for autocomplete. You can use the config `filename` to change its name.
 
 You can configure your `composer.json` to do this each time you update your dependencies:
@@ -132,8 +149,6 @@ The class name will be different from the model, avoiding the IDE duplicate anno
 
 > Please make sure to back up your models, before writing the info.
 
-> You need the _ide_helper.php file to add the QueryBuilder methods. You can add --write-eloquent-helper/-E to generate a minimal version. If this file does not exist, you will be prompted for it.
-
 Writing to the models should keep the existing comments and only append new properties/methods. It will not update changed properties/methods.
 
 With the `--reset (-R)` option, the whole existing PHPDoc is replaced, including any comments that have been made.

resources/views/helper.php

@@ -21,27 +21,24 @@
  * @author Barry vd. Heuvel <[email protected]>
  * @see https://github.com/barryvdh/laravel-ide-helper
  */
-<?php
-$s1 = '    ';
-$s2 = $s1 . $s1;
-$s3 = $s1 . $s2;
-?>
+
 <?php foreach ($namespaces_by_extends_ns as $namespace => $aliases) : ?>
 namespace <?= $namespace === '__root' ? '' : trim($namespace, '\\') ?> {
     <?php foreach ($aliases as $alias) : ?>
-<?php echo trim($alias->getDocComment($s1)) . "\n{$s1}" . $alias->getClassType() ?> <?= $alias->getExtendsClass() ?> {
+        <?= trim($alias->getDocComment('    ')) ?>
+        <?= $alias->getClassType() ?> <?= $alias->getExtendsClass() ?> {
         <?php foreach ($alias->getMethods() as $method) : ?>
-<?= trim($method->getDocComment($s2)) . "\n{$s2}" ?>public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>)
+            <?= trim($method->getDocComment('        ')) ?>
+        public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>)
         {<?php if ($method->getDeclaringClass() !== $method->getRoot()) : ?>
-<?= "\n" . $s3?>//Method inherited from <?= $method->getDeclaringClass() ?>
- <?php endif; ?>
+            //Method inherited from <?= $method->getDeclaringClass() ?>
+         <?php endif; ?>
 
-<?php if ($method->isInstanceCall()) : ?>
-<?= $s3 ?>/** @var <?=$method->getRoot()?> $instance */
-<?php endif?>
-<?= $s3 . ($method->shouldReturn() ? 'return ' : '') ?><?= $method->getRootMethodCall() ?>;
+            <?php if ($method->isInstanceCall()) : ?>
+            /** @var <?=$method->getRoot()?> $instance */
+            <?php endif?>
+            <?= $method->shouldReturn() ? 'return ' : '' ?><?= $method->getRootMethodCall() ?>;
         }
-
         <?php endforeach; ?>
     }
     <?php endforeach; ?>
@@ -51,27 +48,26 @@ namespace <?= $namespace === '__root' ? '' : trim($namespace, '\\') ?> {
 
 <?php foreach ($namespaces_by_alias_ns as $namespace => $aliases) : ?>
 namespace <?= $namespace === '__root' ? '' : trim($namespace, '\\') ?> {
-<?php foreach ($aliases as $alias) : ?>
-<?php if ($alias->getExtendsNamespace() === '\Illuminate\Database\Eloquent') : ?>
-<?= "\n" . $alias->getPhpDocTemplates($s1) . "\n" ?>
-<?php endif?>
-<?= $s1 . $alias->getClassType() ?> <?= $alias->getShortName() ?> extends <?= $alias->getExtends() ?> {<?php if ($alias->getExtendsNamespace() === '\Illuminate\Database\Eloquent') : ?>
-<?php foreach ($alias->getMethods() as $method) : ?>
-<?= $s2 . trim($method->getDocComment($s2)) . "\n" ?>
-<?= $s2 ?>public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>)
-<?= $s2?>{<?php if ($method->getDeclaringClass() !== $method->getRoot()) : ?>
-<?= $s2 ?>//Method inherited from <?= $method->getDeclaringClass() ?>
-<?php endif; ?>
+    <?php foreach ($aliases as $alias) : ?>
+        <?php if ($alias->getExtendsNamespace() === '\Illuminate\Database\Eloquent') : ?>
+        <?= $alias->getPhpDocTemplates('            ') ?>
+        <?php endif?>
+        <?= $alias->getClassType() ?> <?= $alias->getShortName() ?> extends <?= $alias->getExtends() ?> {<?php if ($alias->getExtendsNamespace() === '\Illuminate\Database\Eloquent') : ?>
+            <?php foreach ($alias->getMethods() as $method) : ?>
+                <?= trim($method->getDocComment('            ')) ?>
+            public static function <?= $method->getName() ?>(<?= $method->getParamsWithDefault() ?>)
+            {<?php if ($method->getDeclaringClass() !== $method->getRoot()) : ?>
+                //Method inherited from <?= $method->getDeclaringClass() ?>
+             <?php endif; ?>
 
-<?php if ($method->isInstanceCall()) : ?>
-<?= $s3 ?>/** @var <?=$method->getRoot()?> $instance */
-<?php endif?>
-<?= $s3 . ($method->shouldReturn() ? 'return ' : '') ?><?= $method->getRootMethodCall() ?>;
-<?= $s2 ?>}
-
-<?php endforeach; ?>
-<?php endif; ?>}
-<?php endforeach; ?>
+                <?php if ($method->isInstanceCall()) : ?>
+                /** @var <?=$method->getRoot()?> $instance */
+                <?php endif?>
+                <?= $method->shouldReturn() ? 'return ' : '' ?><?= $method->getRootMethodCall() ?>;
+            }
+            <?php endforeach; ?>
+        <?php endif; ?>}
+    <?php endforeach; ?>
 }
 
 <?php endforeach; ?>