putyourlightson / craft-autocomplete
1.0.1
2021-07-23 11:47 UTC
Requires
- craftcms/cms: ^3.0.0
README
为Craft CMS的自动补全 [已废弃]
⚠️ 此包已被由PutYourLightsOn和nystudio107合作的更优越的 Craft Autocomplete 所替代。
为Craft CMS和插件在Twig模板中提供自动补全。
目前只支持 PhpStorm,因为VSCode不支持Twig扩展的IntelliSense。
改编自nystudio107的FauxTwigExtension.php
,如文章所述
https://nystudio107.com/blog/auto-complete-craft-cms-3-apis-in-twig-with-phpstorm
使用方法
使用composer安装此包。
composer require putyourlightson/craft-autocomplete
确保在PhpStorm中安装并启用了Symfony插件
https://plugins.jetbrains.com/plugin/7219-symfony-plugin
一旦您的IDE索引了文件,Craft和支持的插件在您的Twig模板中的自动补全将立即可用。
添加自定义变量
您可以通过创建一个名为AutocompleteVariable.php
的文件并将其放置在PhpStorm将索引的任何文件夹中(例如在/config
目录中)来为您的自定义模块/插件添加自动补全。
<?php use craft\web\twig\variables\CraftVariable; use my\plugin\variables\MyVariable; /** * Adds variables to the global Craft Variable. * * @mixin MyVariable */ class AutocompleteVariable extends CraftVariable { }
贡献
您可以为插件商店中可用的第三方插件贡献自动补全。为此,复制src/putyourlightson
文件夹并将其重命名为您的GitHub用户名。相应地修改类,并将@mixin
添加到主AutocompleteVariable
类中的变量。
确保遵循现有的结构,测试自动补全是否正常工作,然后提交一个pull request。
由PutYourLightsOn创建。