3721300657

Build Type

push

github

Committed by GitHub

Commit Message

minor: Follow PSR12 ordered imports in Symfony ruleset (#6712)

Run Details

9 of 9 new or added lines in 2 files covered. (100.0%)

22674 of 24281 relevant lines covered (93.38%)

39.08 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

82.35

/src/Fixer/Phpdoc/PhpdocTagCasingFixer.php

<?php

declare(strict_types=1);

/*
 * This file is part of PHP CS Fixer.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *     Dariusz Rumiński <dariusz.ruminski@gmail.com>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace PhpCsFixer\Fixer\Phpdoc;

use PhpCsFixer\AbstractProxyFixer;
use PhpCsFixer\ConfigurationException\InvalidConfigurationException;
use PhpCsFixer\ConfigurationException\InvalidFixerConfigurationException;
use PhpCsFixer\Fixer\ConfigurableFixerInterface;
use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
use PhpCsFixer\FixerDefinition\CodeSample;
use PhpCsFixer\FixerDefinition\FixerDefinition;
use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
use PhpCsFixer\Preg;

final class PhpdocTagCasingFixer extends AbstractProxyFixer implements ConfigurableFixerInterface
{
    /**
     * {@inheritdoc}
     */
    public function getDefinition(): FixerDefinitionInterface
    {
        return new FixerDefinition(
            'Fixes casing of PHPDoc tags.',
            [
                new CodeSample("<?php\n/**\n * @inheritdoc\n */\n"),
                new CodeSample("<?php\n/**\n * @inheritdoc\n * @Foo\n */\n", [
                    'tags' => ['foo'],
                ]),
            ]
        );
    }

    /**
     * {@inheritdoc}
     *
     * Must run before PhpdocAlignFixer.
     * Must run after AlignMultilineCommentFixer, CommentToPhpdocFixer, PhpdocIndentFixer, PhpdocScalarFixer, PhpdocToCommentFixer, PhpdocTypesFixer.
     */
    public function getPriority(): int
    {
        return parent::getPriority();
    }

    public function configure(array $configuration): void
    {
        parent::configure($configuration);

        $replacements = [];
        foreach ($this->configuration['tags'] as $tag) {
            $replacements[$tag] = $tag;
        }

        /** @var GeneralPhpdocTagRenameFixer $generalPhpdocTagRenameFixer */
        $generalPhpdocTagRenameFixer = $this->proxyFixers['general_phpdoc_tag_rename'];

        try {
            $generalPhpdocTagRenameFixer->configure([
                'fix_annotation' => true,
                'fix_inline' => true,
                'replacements' => $replacements,
                'case_sensitive' => false,
            ]);
        } catch (InvalidConfigurationException $exception) {
            throw new InvalidFixerConfigurationException(
                $this->getName(),
                Preg::replace('/^\[.+?\] /', '', $exception->getMessage()),
                $exception
            );
        }
    }

    /**
     * {@inheritdoc}
     */
    protected function createConfigurationDefinition(): FixerConfigurationResolverInterface
    {
        return new FixerConfigurationResolver([
            (new FixerOptionBuilder('tags', 'List of tags to fix with their expected casing.'))
                ->setAllowedTypes(['array'])
                ->setDefault(['inheritDoc'])
                ->getOption(),
        ]);
    }

    /**
     * {@inheritdoc}
     */
    protected function createProxyFixers(): array
    {
        return [new GeneralPhpdocTagRenameFixer()];
    }
}

1	<?php
2
3	declare(strict_types=1);
4
5	/*
6	* This file is part of PHP CS Fixer.
7	*
8	* (c) Fabien Potencier <fabien@symfony.com>
9	* Dariusz Rumiński <dariusz.ruminski@gmail.com>
10	*
11	* This source file is subject to the MIT license that is bundled
12	* with this source code in the file LICENSE.
13	*/
14
15	namespace PhpCsFixer\Fixer\Phpdoc;
16
17	use PhpCsFixer\AbstractProxyFixer;
18	use PhpCsFixer\ConfigurationException\InvalidConfigurationException;
19	use PhpCsFixer\ConfigurationException\InvalidFixerConfigurationException;
20	use PhpCsFixer\Fixer\ConfigurableFixerInterface;
21	use PhpCsFixer\FixerConfiguration\FixerConfigurationResolver;
22	use PhpCsFixer\FixerConfiguration\FixerConfigurationResolverInterface;
23	use PhpCsFixer\FixerConfiguration\FixerOptionBuilder;
24	use PhpCsFixer\FixerDefinition\CodeSample;
25	use PhpCsFixer\FixerDefinition\FixerDefinition;
26	use PhpCsFixer\FixerDefinition\FixerDefinitionInterface;
27	use PhpCsFixer\Preg;
28
29	final class PhpdocTagCasingFixer extends AbstractProxyFixer implements ConfigurableFixerInterface
30	{
31	/**
32	* {@inheritdoc}
33	*/
34	public function getDefinition(): FixerDefinitionInterface
35	{
36	return new FixerDefinition(	3✔
37	'Fixes casing of PHPDoc tags.',	3✔
38	[	3✔
39	new CodeSample("<?php\n/*\n @inheritdoc\n */\n"),	3✔
40	new CodeSample("<?php\n/*\n @inheritdoc\n * @Foo\n */\n", [	3✔
41	'tags' => ['foo'],	3✔
42	]),	3✔
43	]	3✔
44	);	3✔
45	}
46
47	/**
48	* {@inheritdoc}
49	*
50	* Must run before PhpdocAlignFixer.
51	* Must run after AlignMultilineCommentFixer, CommentToPhpdocFixer, PhpdocIndentFixer, PhpdocScalarFixer, PhpdocToCommentFixer, PhpdocTypesFixer.
52	*/
53	public function getPriority(): int
54	{
55	return parent::getPriority();	1✔
56	}
57
58	public function configure(array $configuration): void
59	{
60	parent::configure($configuration);	12✔
61
62	$replacements = [];	12✔
63	foreach ($this->configuration['tags'] as $tag) {	12✔
64	$replacements[$tag] = $tag;	12✔
65	}
66
67	/** @var GeneralPhpdocTagRenameFixer $generalPhpdocTagRenameFixer */
68	$generalPhpdocTagRenameFixer = $this->proxyFixers['general_phpdoc_tag_rename'];	12✔
69
70	try {
71	$generalPhpdocTagRenameFixer->configure([	12✔
72	'fix_annotation' => true,	12✔
73	'fix_inline' => true,	12✔
74	'replacements' => $replacements,	12✔
75	'case_sensitive' => false,	12✔
76	]);	12✔
77	} catch (InvalidConfigurationException $exception) {	×
78	throw new InvalidFixerConfigurationException(	×
79	$this->getName(),	×
80	Preg::replace('/^\[.+?\] /', '', $exception->getMessage()),	×
81	$exception	×
82	);	×
83	}
84	}
85
86	/**
87	* {@inheritdoc}
88	*/
89	protected function createConfigurationDefinition(): FixerConfigurationResolverInterface
90	{
91	return new FixerConfigurationResolver([	12✔
92	(new FixerOptionBuilder('tags', 'List of tags to fix with their expected casing.'))	12✔
93	->setAllowedTypes(['array'])	12✔
94	->setDefault(['inheritDoc'])	12✔
95	->getOption(),	12✔
96	]);	12✔
97	}
98
99	/**
100	* {@inheritdoc}
101	*/
102	protected function createProxyFixers(): array
103	{
104	return [new GeneralPhpdocTagRenameFixer()];	12✔
105	}
106	}

PHP-CS-Fixer / PHP-CS-Fixer / 3721300657

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous