From a14635d0e256183eda86855bcc33102aef927699 Mon Sep 17 00:00:00 2001 From: Bastien Philippe Date: Wed, 5 Aug 2020 12:23:19 +0200 Subject: [PATCH] Update doc --- CHANGELOG.md | 4 ++++ README.md | 9 +++++++++ 2 files changed, 13 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index c94b422..1864cd1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,10 @@ All notable changes to `soyhuce/next-ide-helper` will be documented in this file ## [Next release] - YYYY-MM-DD +### Added + +- command `next-ide-helper:aliases` to generate a file helping the ide to understand aliases + ### Changed - HasOne relations are documented with `has` in factories docblocks diff --git a/README.md b/README.md index 0182066..133b815 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,7 @@ All notable changes are described in the [changelog](CHANGELOG.md). - [Macros](#macros) - [Phpstorm meta](#phpstorm-meta) - [Factories](#factories) + - [Aliases](#aliases) - [Custom application bootstrap](#custom-application-bootstrap) - [Contributing](#contributing) - [License](#license) @@ -364,6 +365,14 @@ class UserFactory extends Factory // } ``` + +## Aliases + +Sometimes we don't want to use fully qualified class names but prefer to use Laravel aliases. + +The command `php artisan next-ide-helper:aliases` will create a file which can be understood by your ide. + +It will then provide auto-completion, syntax hightlight, ... for the aliases defined in your `config/app.php` file as well as the ones defined by the package you use. ## Custom application bootstrap