roniestein/package-macro-autocomplete

一个辅助包,允许 barryvdh/laravel-ide-helper 查找并索引存储在包中的宏

v0.1.1 2020-02-06 15:42 UTC

This package is auto-updated.

Last update: 2024-09-07 05:32:06 UTC


README

PackageMacroAutocomplete 的唯一任务是提取您的宏到文件中,这样 PHPStorm 和可能的其他 IDE 可以读取并将它们放置在您的项目中,以便您获得包宏的自动完成功能。此包旨在用作 barryvdh/laravel-ide-helper 的辅助工具

composer require roniestein/package-macro-autocomplete --dev

在您的包 src 目录中,只需添加文件 AutoCompletionHelper.php

按照以下方式添加您想要导入到 ide 中的宏

<?php
namespace Illuminate\Http;

/**
 * @method bool validate(array $rules, ...$params) Validate the given request with the given rules.
 * @method array validated() Get the validated data from the request.
 */
class Request
{
}


namespace Illuminate\Support;

use App\User;

/**
 * @method bool fiddler($roof) Check if he is on the roof.
 * @method array shaboom($shaboom) La la la la la la la
 * @method User user()
 */
class Collection
{
}

当您准备好导入包中的所有组织良好的宏时,只需运行以下命令

php artisan autocomplete:generate

这将读取每个所需包中的 AutoCompletionHelper.php 文件,并在您的根目录中创建一个 _package_macro_ide_helper.php 文件,其中包含所有宏。PHPStorm 将索引该文件并将列出的宏签名添加到自动完成中。

autocomplete:generate 可以接受一个可选参数,即文件名,但是它将添加 php 扩展名。如果您想要其他名称而不是 _package_macro_ide_helper.php,运行

php artisan autocomplete:generate MyAwesomeFilename

然后 MyAwesomeFilename.php 将添加到您的项目根目录中,以便 PHPStorm 使用。

要将这部分添加到您的构建中,请将命令添加到 composer.json 中的 barryvdh/laravel-ide-helper 更新脚本之后。

"scripts": {
        "post-autoload-dump": [
            "Illuminate\\Foundation\\ComposerScripts::postAutoloadDump",
            "@php artisan package:discover --ansi",
            "@php artisan ide-helper:generate",
            "@php artisan ide-helper:meta"
            "@php artisan autocomplete:generate"
        ],

``