Инструменты разработки

Package Builder может автоматически настроить инструменты статического анализа и линтинга при создании пакета.

PHPStan

Всегда включён. Добавляется в composer.json как dev-зависимость.

Конфигурация

Файл phpstan.neon создаётся автоматически:

parameters:
    level: 5
    paths:
        - src
        - elements
    excludePaths:
        analyse:
            - src/Model
            - vendor

Запуск

cd core/components/mypackage/
composer install
composer analyse

Уровни анализа

PHPStan использует уровень 5 из 9 — строгая проверка типов без излишеств:

• Уровни 0–4: базовые проверки
• Уровень 5: проверка типов аргументов и возвращаемых значений
• Уровни 6–9: максимально строгие проверки

PHP CS Fixer

Опциональный. Включается флагом --php-cs-fixer при создании или ключом phpCsFixer: true в конфиге.

Конфигурация

Файл .php-cs-fixer.dist.php:

<?php
$finder = (new PhpCsFixer\Finder())
    ->in(__DIR__ . '/src')
    ->in(__DIR__ . '/elements')
    ->exclude('Model');

return (new PhpCsFixer\Config())
    ->setRules([
        '@PSR12' => true,
        'array_syntax' => ['syntax' => 'short'],
        'no_unused_imports' => true,
        'ordered_imports' => ['sort_algorithm' => 'alpha'],
        'single_quote' => true,
        'trailing_comma_in_multiline' => true,
    ])
    ->setFinder($finder)
    ->setRiskyAllowed(false);

Запуск

# Проверить код
composer cs-check

# Автоисправить
composer cs-fix

Правила

Правило	Описание
@PSR12	Стандарт PSR-12
array_syntax	Короткий синтаксис массивов []
no_unused_imports	Удаление неиспользуемых use
ordered_imports	Сортировка импортов по алфавиту
single_quote	Одинарные кавычки для строк
trailing_comma_in_multiline	Запятая после последнего элемента

ESLint

Опциональный. Включается флагом --eslint при создании или ключом eslint: true в конфиге.

Конфигурация

Файл eslint.config.js (flat config, ESLint 9+):

import js from '@eslint/js';
import globals from 'globals';

export default [
  {
    ignores: ['node_modules/**', 'lib/**'],
  },
  js.configs.recommended,
  {
    files: ['**/*.js'],
    languageOptions: {
      ecmaVersion: 2022,
      sourceType: 'module',
      globals: {
        ...globals.browser,
      },
    },
    rules: {
      'indent': ['error', 2],
      'quotes': ['error', 'single', { allowTemplateLiterals: true }],
      'semi': ['error', 'always'],
      'no-useless-escape': 'off',
    }
  },
];

Установка и запуск

npm install
npm run lint          # проверить
npm run lint:fix      # автоисправить

Свои конфиги инструментов

По умолчанию при create используются встроенные конфиги. Если вы хотите, чтобы все проекты использовали одинаковые настройки инструментов — создайте папку с вашими конфигами:

~/my-tool-configs/
├── phpstan.neon
├── .php-cs-fixer.dist.php
└── eslint.config.js

Укажите путь к папке в глобальном конфиге:

modxapp config
# → Path to custom tool configs: ~/my-tool-configs

Или в modxapp.json (локальный конфиг проекта):

{
    "toolsConfigPath": "/home/user/my-tool-configs"
}

При modxapp create файлы из этой папки заменят встроенные шаблоны. Не обязательно класть все три файла — если в папке есть только phpstan.neon, заменён будет только он, остальные останутся встроенными.

Автоматические проверки при сборке

При modxapp build перед сборкой автоматически запускаются проверки:

1. PHPStan — если установлен (всегда включён в composer.json)
2. PHP CS Fixer — если включён в конфиге
3. ESLint — если включён в конфиге

Если проверка не прошла — сборка прерывается с выводом ошибок. Это гарантирует, что в transport-пакет попадёт только проверенный код.

# Сборка с проверками (по умолчанию)
modxapp build mypackage

# Пропустить проверки
modxapp build mypackage --no-check

Режим PHP CS Fixer

В config.php пакета можно настроить поведение CS Fixer при сборке:

'tools' => [
    'phpCsFixer' => true,
    'csFixerMode' => 'fix',    // 'fix' — автоисправление (по умолчанию)
                                // 'check' — только проверка, сборка прервётся при ошибках
],

• fix — автоматически исправит стиль кода перед сборкой
• check — покажет ошибки, но не изменит файлы; сборка прервётся

Зависимости должны быть установлены

Проверки запускаются только если инструменты установлены. Если vendor/ отсутствует — проверка пропускается с предупреждением. Запустите composer install в папке пакета.

Настройка IDE

Для подсветки ошибок в процессе разработки (без ожидания сборки) настройте инструменты в вашем редакторе:

PhpStorm

• PHPStan: Settings → PHP → Quality Tools → PHPStan → указать путь к vendor/bin/phpstan и конфиг phpstan.neon
• PHP CS Fixer: Settings → PHP → Quality Tools → PHP CS Fixer → указать путь к vendor/bin/php-cs-fixer
• ESLint: Settings → Languages & Frameworks → JavaScript → Code Quality Tools → ESLint → Automatic configuration

VS Code

Установите расширения:

• PHPStan — подсветка ошибок PHPStan
• PHP CS Fixer — автоформатирование при сохранении
• ESLint — подсветка JS ошибок

После установки расширений ошибки будут подсвечиваться прямо в коде — без необходимости запускать build.

Сборка пакета

Все файлы инструментов (phpstan.neon, .php-cs-fixer.dist.php, eslint.config.js, package.json, node_modules/) автоматически исключаются из transport-пакета через .packignore.