lukaskleinschmidt/kirby-types

Kirby 类型

维护者

详细信息

github.com/lukaskleinschmidt/kirby-types

源代码

问题

安装: 194

依赖: 1

建议者: 0

安全: 0

星星: 18

观察者: 2

分支: 0

开放问题: 1

类型:kirby-plugin

2.0.1 2023-09-13 15:14 UTC

Requires

Requires (Dev)

MIT b4ee27371c3636ba00a783090907537587b3b0ad

  • Lukas Kleinschmidt <contact.woop@kleinschmidt.mozmail.com>

This package is auto-updated.

Last update: 2024-09-13 17:51:05 UTC

README

为您的 IDE 提供额外的和扩展的类型提示。
向您的项目中添加 kirby types:create 命令。
此命令将在您的项目根目录中创建一个文件，您的 IDE 会选择该文件。

注意 确保已安装 getkirby/cli 以使用此命令

安装

使用以下命令通过 composer 需求此包。

composer require --dev lukaskleinschmidt/kirby-types:^1.1

用法

只需运行 kirby types:create 命令即可创建类型提示文件。

命令选项

在运行命令时，您可以设置 filename、force 和 include 选项。

kirby types:create --filename my-ide-helper --force --include

选项

您可以在 config.php 中使用以下选项。
这些是插件的默认选项。

return [
    'lukaskleinschmidt.types' => [
        'aliases'    => [],
        'decorators' => [],
        'filename'   => 'types.php',
        'force'      => false,
        'include'    => [
            'aliases',
            'blueprints',
            'decorators',
            'methods',
        ],
    ],
];

别名

您可以添加您想包含的自定义别名。

return [
    'lukaskleinschmidt.types' => [
        'aliases' => [
            'MyClass' => \LukasKleinschmidt\MyClass::class,
        ],
    ],
];

装饰器

您可以通过修改方法和它们的 DocBlock 来改进 IDE 类型提示。
该插件已定义了一些默认装饰器。

use LukasKleinschmidt\Types\Method;
use Kirby\Cms\Layout;

return [
    'lukaskleinschmidt.types' => [
        'decorators' => [
            Layout::class => [
                'columns' => [
                    '@return \Kirby\Cms\LayoutColumns|\Kirby\Cms\LayoutColumn[]',
                ],
            ],
        ],
    ],
];

许可协议

MIT

致谢