README

Generate IDE metadata for Laravel packages (and apps) that ship class-based Blade components:

• VS Code snippets (<base>.code-snippets) — zero-install completion of <x-…> tags.
• VS Code Custom Data (<base>.html-data.json) — consumed by a dedicated VS Code extension.
• PhpStorm / Laravel Idea (ide.json) — tag → component-class mapping, auto-merged by Laravel Idea.

It is a small, framework-only library: you describe your components with a ComponentDefinition, and either extend the provided AbstractIdeCommand or call the services directly.

Installation

composer require --dev forxer/blade-components-ide-helper

Use a plain (non-dev) require instead if your package calls any of this library's services at runtime — for example reusing Reflection\AttributeReflector to hydrate component attributes — rather than only generating IDE metadata.

The contract: ComponentDefinition

use Forxer\BladeComponentsIdeHelper\Definition\ComponentDefinition;

$definition = new ComponentDefinition(
    components: ['alert' => Alert::class, 'badge' => Badge::class], // alias => class
    prefix: '',                                                     // <x-alert> vs <x-bs-alert>
    // attributeSurface: ...   (see below — defaults to constructor parameters)
    // slotStrategy: ...       (see below — defaults to view scanning)
    // snippetValueAttributes: ['variant'],  // which attribute gets a value dropdown in snippets
);

Attribute surfaces — what counts as a settable attribute

• ConstructorParametersSurface (default): constructor parameters only. Correct for a standard Illuminate component, whose settable attributes are exactly its constructor parameters.
• PropertiesAndConstructorSurface: the union of public settable properties and constructor parameters. Use it when your components hydrate public properties in addition to constructor arguments.

Both read descriptions and constrained value sets from docblocks: a property's summary and its @var 'a'|'b' literal union, or a constructor parameter's @param summary.

You can supply your own by implementing Forxer\BladeComponentsIdeHelper\Attributes\AttributeSurface.

Slot strategies — does the component accept inner content?

• ViewScanningSlotStrategy (default): instantiates the component with dummy arguments, calls render(), and scans the resolved view (file or inline string) for $slot. Any failure degrades to "no slot" (self-closing snippet).
• NullSlotStrategy: always reports no slot.

Implement Forxer\BladeComponentsIdeHelper\Slots\SlotStrategy for a custom rule.

Wiring a command

Extend AbstractIdeCommand: provide the $signature (with the standard option set), a definition(), and a fileBaseName().

use Forxer\BladeComponentsIdeHelper\Attributes\PropertiesAndConstructorSurface;
use Forxer\BladeComponentsIdeHelper\Commands\AbstractIdeCommand;
use Forxer\BladeComponentsIdeHelper\Definition\ComponentDefinition;

class IdeCommand extends AbstractIdeCommand
{
    protected $signature = 'my-package:ide
        {--output= : Output directory for the VS Code files (default: .vscode)}
        {--ide-output= : Output directory for ide.json}
        {--snippets : Generate the VS Code snippets file}
        {--json : Generate the VS Code Custom Data file}
        {--ide-json : Generate the PhpStorm/Laravel Idea ide.json file}';

    protected $description = 'Generate IDE metadata for the components';

    protected function definition(): ComponentDefinition
    {
        return new ComponentDefinition(
            components: config('my-package.components'),
            prefix: (string) config('my-package.prefix', ''),
            attributeSurface: new PropertiesAndConstructorSurface(),
        );
    }

    protected function fileBaseName(): string
    {
        return 'my-package';
    }
}

Running it writes .vscode/my-package.code-snippets, .vscode/my-package.html-data.json, and ide-helper/my-package/ide.json.

Multiple packages side by side

Each consumer writes files under its own base name, so several packages coexist without collision: VS Code loads every *.code-snippets, and Laravel Idea recursively merges every ide.json. The ide.json is written to a package-owned subfolder (ide-helper/<base>/), never the shared project root and never .vscode/.

License

MIT