studiolemon/wp-lemon-rector

Rector ruleset for WP Lemon projects

dev-master 2025-10-24 08:55 UTC

Requires

• php: ^8.3
• rector/rector: ^2.0

MIT

• Studio Lemon

README

A comprehensive Rector package with custom rules specifically designed for WP Lemon projects. This package includes Rector itself along with custom transformation rules for the Bulldozer block framework.

Installation

Install this package in your WP Lemon project using Composer:

composer require --dev studiolemon/wp-lemon-rector

This will install Rector along with all custom WP Lemon rules.

Usage

Since this package includes Rector, you can run it directly:

# Using the WP Lemon Rector executable
vendor/bin/wp-lemon-rector process path/to/your/blocks --dry-run
vendor/bin/wp-lemon-rector process path/to/your/blocks

# Or using Rector directly
vendor/bin/rector process path/to/your/blocks --dry-run
vendor/bin/rector process path/to/your/blocks

Project Configuration (Optional)

If you want to customize paths or add additional rules, create a rector.php file in your project root:

<?php

declare(strict_types=1);

use Rector\Config\RectorConfig;

return RectorConfig::configure()
    ->withPaths([
        __DIR__ . '/wp-content/themes/your-theme/blocks',
        __DIR__ . '/wp-content/plugins/your-plugin/src',
    ])
    // Import the WP Lemon Rector configuration
    ->withSets([
        __DIR__ . '/vendor/studiolemon/wp-lemon-rector/rector.php',
    ]);

Custom Rules

This package includes custom Rector rules tailored for WP Lemon's Bulldozer block framework:

1. ClassesArrayToAddClassMethodRector

Transforms array assignments to the add_class() method:

// Before
$this->classes[] = 'section hero alignfull has-background';

// After
$this->add_class(['section', 'hero', 'alignfull', 'has-background']);

2. MergeConsecutiveAddClassCallsRector

Optimizes multiple consecutive add_class() calls by merging them into a single call:

// Before
$this->add_class(['bg-pill']);
$this->add_class(['section', 'has-background']);

// After
$this->add_class(['bg-pill', 'section', 'has-background']);

3. AttributesAlignToSetAlignmentRector

Transforms the align attribute assignment to the set_alignment() method:

// Before
$this->attributes['align'] = 'full';

// After
$this->set_alignment('full');

4. AttributesIdToSetAnchorRector

Transforms the id attribute assignment to the set_anchor() method:

// Before
$this->attributes['id'] = 'formulier';

// After
$this->set_anchor('formulier');

5. AttributesArrayToSetAttributeMethodRector

Fallback transformation for attribute assignments into set_attribute() when no more-specific rule applies:

// Before
$this->attributes['foo'] = 'bar';

// After
$this->set_attribute('foo', 'bar');

6. FieldsArrayToGetFieldMethodRector

Transforms field array access to the get_field() method:

// Before
$value = $this->fields['image_field'];

// After
$value = $this->get_field('image_field');

7. IsPreviewPropertyToMethodRector

Transforms is_preview property access to method call:

// Before
if ($this->is_preview) {
    // do something
}

// After
if ($this->is_preview()) {
    // do something
}

8. InnerBlocksStringToMethodRector

Transforms InnerBlocks HTML string concatenation to the create_inner_blocks() method:

// Before
'InnerBlocks' => '<InnerBlocks allowedBlocks="' . esc_attr(wp_json_encode($allowed_blocks)) . '" template="' . esc_attr(wp_json_encode($template)) . '" />'

// After
'InnerBlocks' => self::create_inner_blocks($allowed_blocks, $template)

Standard Rector Sets

In addition to custom rules, this package includes:

• PHP 8.3+ Features: Modern PHP syntax and features
• Dead Code Removal: Removes unused code and variables
• Code Quality: Improves overall code quality
• Coding Style: Enforces consistent coding standards
• Type Declarations: Adds type hints where possible
• Privatization: Makes properties and methods private when possible
• Naming: Improves variable and method naming
• Early Return: Promotes early return patterns
• Strict Booleans: Enforces strict boolean comparisons

WordPress Compatibility

Some rules are intentionally skipped to maintain compatibility with WordPress:

• StaticClosureRector - WordPress often uses dynamic closures
• StaticArrowFunctionRector - WordPress often uses dynamic arrow functions
• ReadOnlyPropertyRector - May conflict with WordPress patterns

Contributing

Contributions are welcome! To add or modify rules:

1. Edit or add Rector rules in the src/ directory
2. Update the rector.php configuration to register new rules
3. Add test cases in tests/blocks/
4. Submit a pull request

License

MIT