Skip to content

ddtcorex/maestro-skills / skills/magento2-dev-core

magento2-dev-core

Verified

Use for Magento 2 module work: architecture, dependency injection, repositories, plugins, secure backend code, CLI, cron. Core skill, always load it first. Keywords dependency injection, plugin.

references/coding-standards.md

View on GitHub
# Coding Standards Reference

This document provides detailed coding standards for Magento 2 development.

## PHPCS Rules (Magento2 Standard)

### File Structure

```php
<?php
/**
 * Vendor Name
 * Copyright (c) [YEAR] [Vendor Name]
 * See LICENSE for license details.
 */

declare(strict_types=1);
```

### Class Structure

```php
<?php
/**
 * Vendor Name
 * Copyright (c) [YEAR] [Vendor Name]
 * See LICENSE for license details.
 */

declare(strict_types=1);

namespace Vendor\Module\Controller\Index;

use Magento\Framework\App\Action\HttpGetActionInterface;
use Magento\Framework\Controller\Result\JsonFactory;
use Magento\Framework\Controller\Result\Json as JsonResult;

/**
 * Index controller for module
 */
class Index implements HttpGetActionInterface
{
    public function __construct(
        private readonly JsonFactory $resultJsonFactory
    ) {
    }

    /**
     * Execute controller
     *
     * @return JsonResult
     */
    public function execute(): JsonResult
    {
        return $this->resultJsonFactory->create()->setData(['success' => true]);
    }
}
```

### Naming Conventions

| Element | Convention | Example |
|---------|------------|---------|
| Classes | PascalCase | `ProductRepository` |
| Interfaces | PascalCase + Interface suffix | `ProductInterface` |
| Methods | camelCase | `getProductById()` |
| Properties | camelCase | `$productId` |
| Constants | UPPER_SNAKE_CASE | `CACHE_TAG` |
| Private props | camelCase, no underscore prefix (legacy core uses `$_name`; a subclass keeps inherited ones such as `$_eventPrefix`, `$_template`) | `$cacheIdPrefix` |
| Tables | snake_case | `sales_order_item` |
| Columns | snake_case | `customer_id` |

### Type Hints

Always use strict type hints:

```php
// String types
public function setName(string $name): self;

// Return types
public function getId(): int;

// Nullable types
public function getOptional(): ?string;

// Union types (PHP 8+)
public function process(int|string $input): int|string;

// Void return
public function save(ProductInterface $product): void;
```

### PHPCS Configuration

```xml
<?xml version="1.0"?>
<!-- phpcs.xml: the standard is a <rule ref>, never <arg name="standard">
     (PHPCS answers `option "--standard" not known`), and an <arg> takes its
     value in the value attribute. -->
<ruleset name="VendorModule">
    <description>Vendor Module coding standard</description>
    <file>app/code/Vendor/Module</file>
    <exclude-pattern>*/Test/*</exclude-pattern>
    <rule ref="Magento2"/>
    <arg name="encoding" value="utf-8"/>
    <arg name="tab-width" value="4"/>
</ruleset>
```

## PHPStan Configuration

```neon
# phpstan.neon
parameters:
    level: 6
    paths:
        - app/code/Vendor/Module
    excludePaths:
        - app/code/Vendor/Module/Test
    reportUnmatchedIgnoredErrors: false
    ignoreErrors:
        # PHPStan 2 removed checkGenericClassInNonGenericObjectType; the old key
        # is now an error identifier, not a parameter.
        - identifier: missingType.generics
        - '#Call to an undefined method Mage_.*#'
```

## Common PHPCS Violations

| Error | Correct | Wrong |
|-------|---------|-------|
| Missing docblock | `/** @var Product */` | `/** @var */` |
| Unused use | Remove or use | `use Unused\Class` |
| Line too long | Split line | Continuation on column 200 |
| Blank line after import | `use X;↵↵class` | `use X;↵class` |
| Missing license header | Add header | No header |

## Automated Commands

```bash
# Run PHPCS
vendor/bin/phpcs --standard=Magento2 app/code/Vendor/Module

# Fix auto-fixable issues
vendor/bin/phpcbf --standard=Magento2 app/code/Vendor/Module

# Run PHPStan
vendor/bin/phpstan analyse app/code/Vendor/Module -c phpstan.neon

# Combined check
vendor/bin/phpcs --standard=Magento2 app/code/Vendor/Module && \
vendor/bin/phpstan analyse app/code/Vendor/Module -c phpstan.neon
```
reverse-engineer-anythingmorluto/reaReverse engineer native, managed, Electron/JavaScript, packaged, firmware, and browser targets with REA, and build agent environments (AgentEnv bundles) of web applications from a live instance or a capture, and of Linux desktop apps with a task from a request. Use shipped-artifact or requested runtime evidence to explain features, compare versions, decompile code, or guide a reconstruction. Skip REA for ordinary source-repository architecture analysis.Stars: 471kUpdated Claude CodeCodexVerifiedInstall
diagnosing-superpowersobra/superpowersUse when a superpowers session went wrong and your human partner wants to know why — repeated work, ignored plans, stumbles, poor results, a skill that didn't fire, "it took too long", "why is it so expensive", "what is it doing" — or wants to build a bug report for the superpowers maintainers, for the current session or a past one identified by id or path, on any harness.Stars: 322kUpdated Claude CodeCodexVerifiedInstall
dispatching-parallel-agentsobra/superpowersUse when facing 2+ independent tasks that can be worked on without shared state or sequential dependenciesStars: 322kUpdated Claude CodeCodexVerifiedInstall
executing-plansobra/superpowersUse when executing an implementation plan in the current session as the implementer yourself — your human partner chose inline execution, or no subagent tool is availableStars: 322kUpdated Claude CodeCodexVerifiedInstall