.php_cs.dist

<?php

$finder = PhpCsFixer\Finder::create()
    ->files()
    ->name('*.php')
    ->name('*.inc')
    ->in([__DIR__ . '/examples', __DIR__ . '/src', __DIR__ . '/tests']);

/**
 * The 'header_comment' validation was removed because the copyright year needs to be pinned to the year the file was
 * added to the repo.
 * @todo: Add a copyright validation (https://github.com/apigee/apigee-client-php/issues/81).
 */
return PhpCsFixer\Config::create()
    ->setRiskyAllowed(true)
    ->setRules([
        '@PSR2' => true,
        '@Symfony' => true,
        'array_syntax' => ['syntax' => 'short'],
        'class_definition' => ['singleLine' => false, 'singleItemSingleLine' => true],
        'concat_space' => ['spacing' => 'one'],
        'general_phpdoc_annotation_remove' => ['author'],
        'ordered_class_elements' => true,
        'ordered_imports' => true,
        'phpdoc_align' => false,
        'phpdoc_annotation_without_dot' => false,
        'phpdoc_indent' => false,
        'phpdoc_inline_tag' => false,
        'phpdoc_order' => true,
        // Disabled because fluent setters return type in an interface can not be self.
        'self_accessor' => false,
        'void_return' => true,
        // Disabled because we want to keep all param and return tags.
        'no_superfluous_phpdoc_tags' => false,
        // Disabled because multiple lines allow code clarity.
        'single_line_throw' => false,
        // Disabled because phpcs fails for php8.1 if there is '&' in the argument.
        // see https://github.com/apigee/apigee-client-php/issues/233
        'function_typehint_space' => false,
    ])
    ->setFinder($finder);