Allow rules to be configured for specific paths only

[ruudk]

I'd like to enable a few rules only for specific directories.

I solved it by creating a rule that wraps another rule like this:

<?php

declare(strict_types=1);

namespace Dev\TicketSwap\Shared\Infrastructure\Twig;

use Override;
use Twig\Environment;
use Twig\Node\Node;
use TwigCsFixer\Report\Report;
use TwigCsFixer\Rules\Node\NodeRuleInterface;
use Webmozart\Assert\Assert;

final readonly class PathSpecificRule implements NodeRuleInterface
{
    /**
     * @param list<string> $paths
     */
    public function __construct(
        private array $paths,
        private NodeRuleInterface $rule,
    ) {}

    #[Override]
    public function setReport(Report $report, array $ignoredViolations = []) : void
    {
        $this->rule->setReport($report, $ignoredViolations);
    }

    #[Override]
    public function enterNode(Node $node, Environment $env) : Node
    {
        Assert::notNull($node->getSourceContext(), 'Node has no source context');

        if ( ! array_any($this->paths, fn(string $path) => fnmatch($path, $node->getSourceContext()->getName()))) {
            return $node;
        }

        return $this->rule->enterNode($node, $env);
    }

    #[Override]
    public function leaveNode(Node $node, Environment $env) : ?Node
    {
        Assert::notNull($node->getSourceContext(), 'Node has no source context');

        if ( ! array_any($this->paths, fn(string $path) => fnmatch($path, $node->getSourceContext()->getName()))) {
            return $node;
        }

        return $this->rule->leaveNode($node, $env);
    }

    #[Override]
    public function getPriority() : int
    {
        return $this->rule->getPriority();
    }
}

$ruleset->addRule(
     new PathSpecificRule(
         ['templates/mail/**'],
         new ForbiddenFunctionRule(['path']),
     ),
 );

But would be great to have this natively supported.

[VincentLanglet]

Hi,

It might be doable with something like this: https://github.com/VincentLanglet/Twig-CS-Fixer/pull/382/files

But I'm unsure this will be merged since:

• I don't think other tools have such feature (does PHP CS fixer does ?)
• It lacks tests
• It use absolute path when relative should be preferred (cause with your example templates/mal/my_project/src is ignored too)
• You ends up with multiple PathAwareRule and the method Ruleset::removeRule will remove all of them if you try to override a standard, so we need to introduce a Ruleset method first.

    public function removeRule(string $class): self
    {
        foreach ($this->rules as $key => $rule) {
            if ($rule::class === $class) {
                unset($this->rules[$key]);
            }
        }

        return $this;
    }

But I'm open to discussions

[landure]

FYI, PHPStan has this feature:

    ignoreErrors:
        -
            identifier: staticMethod.alreadyNarrowedType
            path: tests/*

Psalm too, you can suppress a rule for a given path:

        <RedundantPropertyInitializationCheck>
            <errorLevel type="suppress">
                <directory name="src/*/Entity" />
                <directory name="src/*/Document" />
            </errorLevel>
        </RedundantPropertyInitializationCheck>