Allow to skip non fixable rules

VincentLanglet · Jan 26, 2024 · f111b6e · f111b6e
1 parent 7139f95
commit f111b6e
Show file tree

Hide file tree

Showing 22 changed files with 180 additions and 84 deletions.
diff --git a/.github/workflows/qa.yaml b/.github/workflows/qa.yaml
@@ -54,5 +54,5 @@ jobs:
                   dependency-versions: highest
                   composer-options: --prefer-dist --prefer-stable
 
-            - name: Run PHP Code Sniffer
+            - name: Run Psalm
               run: vendor/bin/psalm --no-progress --output-format=github --shepherd
diff --git a/src/Command/TwigCsFixerCommand.php b/src/Command/TwigCsFixerCommand.php
@@ -107,7 +107,7 @@ private function resolveConfig(InputInterface $input, OutputInterface $output):
         $config = $configResolver->resolveConfig(
             $input->getArgument('paths'),
             $input->getOption('config'),
-            $input->getOption('no-cache')
+            $input->getOption('no-cache'),
         );
 
         $cacheFile = $config->getCacheFile();
@@ -130,7 +130,7 @@ private function runLinter(Config $config, InputInterface $input, OutputInterfac
         $report = $linter->run(
             $config->getFinder(),
             $config->getRuleset(),
-            $input->getOption('fix') ? new Fixer($tokenizer) : null
+            $input->getOption('fix') ? new Fixer($tokenizer) : null,
         );
 
         $reporterFactory = new ReporterFactory();

diff --git a/src/Config/Config.php b/src/Config/Config.php
@@ -39,6 +39,8 @@ final class Config
      */
     private array $tokenParsers = [];
 
+    private bool $useOnlyFixableRules = true;
+
     public function __construct(private string $name = 'Default')
     {
         $this->ruleset = new Ruleset();
@@ -143,4 +145,19 @@ public function getTokenParsers(): array
     {
         return $this->tokenParsers;
     }
+
+    /**
+     * @return $this
+     */
+    public function useOnlyFixableRules(bool $useOnlyFixableRules = true): self
+    {
+        $this->useOnlyFixableRules = $useOnlyFixableRules;
+
+        return $this;
+    }
+
+    public function getUseOnlyFixableRules(): bool
+    {
+        return $this->useOnlyFixableRules;
+    }
 }
diff --git a/src/Config/ConfigResolver.php b/src/Config/ConfigResolver.php
@@ -34,19 +34,22 @@ public function __construct(private string $workingDir)
     public function resolveConfig(
         array $paths = [],
         ?string $configPath = null,
-        bool $disableCache = false
+        bool $disableCache = false,
     ): Config {
         $config = $this->getConfig($configPath);
         $config->setFinder($this->resolveFinder($config->getFinder(), $paths));
 
+        // Override ruleset with config
+        $config->getRuleset()->useOnlyFixableRules($config->getUseOnlyFixableRules());
+
         if ($disableCache) {
             $config->setCacheFile(null);
             $config->setCacheManager(null);
         } else {
             $config->setCacheManager($this->resolveCacheManager(
                 $config->getCacheManager(),
                 $config->getCacheFile(),
-                $config->getRuleset()
+                $config->getRuleset(),
             ));
         }
 
@@ -132,7 +135,7 @@ private function resolveFinder(Finder $finder, array $paths): Finder
     private function resolveCacheManager(
         ?CacheManagerInterface $cacheManager,
         ?string $cacheFile,
-        Ruleset $ruleset
+        Ruleset $ruleset,
     ): ?CacheManagerInterface {
         if (null !== $cacheManager) {
             return $cacheManager;
@@ -147,7 +150,7 @@ private function resolveCacheManager(
             Signature::fromRuleset(
                 \PHP_VERSION,
                 InstalledVersions::getReference(self::PACKAGE_NAME) ?? '0',
-                $ruleset
+                $ruleset,
             )
         );
     }

diff --git a/src/Rules/AbstractFixableRule.php b/src/Rules/AbstractFixableRule.php
@@ -0,0 +1,58 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TwigCsFixer\Rules;
+
+use TwigCsFixer\Report\Report;
+use TwigCsFixer\Runner\FixerInterface;
+use TwigCsFixer\Token\Token;
+
+abstract class AbstractFixableRule extends AbstractRule implements FixableRuleInterface
+{
+    private ?FixerInterface $fixer = null;
+
+    protected function init(
+        ?Report $report,
+        array $ignoredViolations = [],
+        ?FixerInterface $fixer = null
+    ): void {
+        parent::init($report, $ignoredViolations);
+        $this->fixer = $fixer;
+    }
+
+    public function fixFile(array $stream, FixerInterface $fixer, array $ignoredViolations = []): void
+    {
+        $this->init(null, $ignoredViolations, $fixer);
+
+        foreach (array_keys($stream) as $index) {
+            $this->process($index, $stream);
+        }
+    }
+
+    protected function addFixableWarning(
+        string $message,
+        Token $token,
+        ?string $messageId = null
+    ): ?FixerInterface {
+        $added = $this->addWarning($message, $token, $messageId);
+        if (!$added) {
+            return null;
+        }
+
+        return $this->fixer;
+    }
+
+    protected function addFixableError(
+        string $message,
+        Token $token,
+        ?string $messageId = null
+    ): ?FixerInterface {
+        $added = $this->addError($message, $token, $messageId);
+        if (!$added) {
+            return null;
+        }
+
+        return $this->fixer;
+    }
+}
diff --git a/src/Rules/AbstractRule.php b/src/Rules/AbstractRule.php
@@ -8,15 +8,12 @@
 use TwigCsFixer\Report\Report;
 use TwigCsFixer\Report\Violation;
 use TwigCsFixer\Report\ViolationId;
-use TwigCsFixer\Runner\FixerInterface;
 use TwigCsFixer\Token\Token;
 
 abstract class AbstractRule implements RuleInterface
 {
     private ?Report $report = null;
 
-    private ?FixerInterface $fixer = null;
-
     /**
      * @var list<ViolationId>
      */
@@ -36,24 +33,20 @@ public function getShortName(): string
 
     public function lintFile(array $stream, Report $report, array $ignoredViolations = []): void
     {
-        $this->report = $report;
-        $this->fixer = null;
-        $this->ignoredViolations = $ignoredViolations;
+        $this->init($report, $ignoredViolations);
 
         foreach (array_keys($stream) as $index) {
             $this->process($index, $stream);
         }
     }
 
-    public function fixFile(array $stream, FixerInterface $fixer, array $ignoredViolations = []): void
+    /**
+     * @param list<ViolationId> $ignoredViolations
+     */
+    protected function init(?Report $report, array $ignoredViolations = []): void
     {
-        $this->report = null;
-        $this->fixer = $fixer;
+        $this->report = $report;
         $this->ignoredViolations = $ignoredViolations;
-
-        foreach (array_keys($stream) as $index) {
-            $this->process($index, $stream);
-        }
     }
 
     /**
@@ -170,32 +163,6 @@ protected function addFileError(string $message, Token $token, ?string $messageI
         );
     }
 
-    protected function addFixableWarning(
-        string $message,
-        Token $token,
-        ?string $messageId = null
-    ): ?FixerInterface {
-        $added = $this->addWarning($message, $token, $messageId);
-        if (!$added) {
-            return null;
-        }
-
-        return $this->fixer;
-    }
-
-    protected function addFixableError(
-        string $message,
-        Token $token,
-        ?string $messageId = null
-    ): ?FixerInterface {
-        $added = $this->addError($message, $token, $messageId);
-        if (!$added) {
-            return null;
-        }
-
-        return $this->fixer;
-    }
-
     private function addMessage(
         int $messageType,
         string $message,

diff --git a/src/Rules/AbstractSpacingRule.php b/src/Rules/AbstractSpacingRule.php
@@ -9,7 +9,7 @@
 /**
  * Ensures there is one space before or after some tokens
  */
-abstract class AbstractSpacingRule extends AbstractRule
+abstract class AbstractSpacingRule extends AbstractFixableRule
 {
     protected function process(int $tokenPosition, array $tokens): void
     {

diff --git a/src/Rules/ConfigurableRuleInterface.php b/src/Rules/ConfigurableRuleInterface.php
@@ -7,7 +7,7 @@
 interface ConfigurableRuleInterface extends RuleInterface
 {
     /**
-     * @return array<mixed>
+     * @return array<string, mixed>
      */
     public function getConfiguration(): array;
 }
diff --git a/src/Rules/FixableRuleInterface.php b/src/Rules/FixableRuleInterface.php
@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace TwigCsFixer\Rules;
+
+use TwigCsFixer\Report\ViolationId;
+use TwigCsFixer\Runner\FixerInterface;
+use TwigCsFixer\Token\Token;
+
+interface FixableRuleInterface
+{
+    /**
+     * @param array<int, Token> $stream
+     * @param list<ViolationId> $ignoredViolations
+     */
+    public function fixFile(array $stream, FixerInterface $fixer, array $ignoredViolations = []): void;
+}
diff --git a/src/Rules/Operator/OperatorNameSpacingRule.php b/src/Rules/Operator/OperatorNameSpacingRule.php
@@ -4,13 +4,13 @@
 
 namespace TwigCsFixer\Rules\Operator;
 
-use TwigCsFixer\Rules\AbstractRule;
+use TwigCsFixer\Rules\AbstractFixableRule;
 use TwigCsFixer\Token\Token;
 
 /**
  * Ensures there is no consecutive spaces inside operator names.
  */
-final class OperatorNameSpacingRule extends AbstractRule
+final class OperatorNameSpacingRule extends AbstractFixableRule
 {
     protected function process(int $tokenPosition, array $tokens): void
     {

diff --git a/src/Rules/Punctuation/TrailingCommaSingleLineRule.php b/src/Rules/Punctuation/TrailingCommaSingleLineRule.php
@@ -4,14 +4,14 @@
 
 namespace TwigCsFixer\Rules\Punctuation;
 
-use TwigCsFixer\Rules\AbstractRule;
+use TwigCsFixer\Rules\AbstractFixableRule;
 use TwigCsFixer\Token\Token;
 use Webmozart\Assert\Assert;
 
 /**
  * Ensures that single-line arrays, objects and argument lists do not have a trailing comma.
  */
-final class TrailingCommaSingleLineRule extends AbstractRule
+final class TrailingCommaSingleLineRule extends AbstractFixableRule
 {
     protected function process(int $tokenPosition, array $tokens): void
     {

diff --git a/src/Rules/RuleInterface.php b/src/Rules/RuleInterface.php
@@ -6,7 +6,6 @@
 
 use TwigCsFixer\Report\Report;
 use TwigCsFixer\Report\ViolationId;
-use TwigCsFixer\Runner\FixerInterface;
 use TwigCsFixer\Token\Token;
 
 interface RuleInterface
@@ -18,10 +17,4 @@ interface RuleInterface
      * @param list<ViolationId> $ignoredViolations
      */
     public function lintFile(array $stream, Report $report, array $ignoredViolations = []): void;
-
-    /**
-     * @param array<int, Token> $stream
-     * @param list<ViolationId> $ignoredViolations
-     */
-    public function fixFile(array $stream, FixerInterface $fixer, array $ignoredViolations = []): void;
 }
diff --git a/src/Rules/Variable/VariableNameRule.php b/src/Rules/Variable/VariableNameRule.php
@@ -8,6 +8,7 @@
 use TwigCsFixer\Rules\AbstractRule;
 use TwigCsFixer\Rules\ConfigurableRuleInterface;
 use TwigCsFixer\Token\Token;
+use Webmozart\Assert\Assert;
 
 final class VariableNameRule extends AbstractRule implements ConfigurableRuleInterface
 {
@@ -38,10 +39,8 @@ protected function process(int $tokenPosition, array $tokens): void
             return;
         }
 
-        $nameTokenPosition = $this->findNext(Token::NAME_TYPE, $tokens, $tokenPosition + 1);
-        if (false === $nameTokenPosition) {
-            return;
-        }
+        $nameTokenPosition = $this->findNext(Token::NAME_TYPE, $tokens, $tokenPosition);
+        Assert::notFalse($nameTokenPosition, 'A BLOCK_NAME_TYPE set must be followed by a name');
         $name = $tokens[$nameTokenPosition]->getValue();
 
         $expected = match ($this->case) {

diff --git a/src/Rules/Whitespace/BlankEOFRule.php b/src/Rules/Whitespace/BlankEOFRule.php
@@ -4,13 +4,13 @@
 
 namespace TwigCsFixer\Rules\Whitespace;
 
-use TwigCsFixer\Rules\AbstractRule;
+use TwigCsFixer\Rules\AbstractFixableRule;
 use TwigCsFixer\Token\Token;
 
 /**
  * Ensures that files end with one blank line.
  */
-final class BlankEOFRule extends AbstractRule
+final class BlankEOFRule extends AbstractFixableRule
 {
     protected function process(int $tokenPosition, array $tokens): void
     {

diff --git a/src/Rules/Whitespace/EmptyLinesRule.php b/src/Rules/Whitespace/EmptyLinesRule.php
@@ -4,14 +4,14 @@
 
 namespace TwigCsFixer\Rules\Whitespace;
 
-use TwigCsFixer\Rules\AbstractRule;
+use TwigCsFixer\Rules\AbstractFixableRule;
 use TwigCsFixer\Token\Token;
 use Webmozart\Assert\Assert;
 
 /**
  * Ensures that 2 empty lines do not follow each other.
  */
-final class EmptyLinesRule extends AbstractRule
+final class EmptyLinesRule extends AbstractFixableRule
 {
     protected function process(int $tokenPosition, array $tokens): void
     {

diff --git a/src/Rules/Whitespace/IndentRule.php b/src/Rules/Whitespace/IndentRule.php
@@ -4,14 +4,14 @@
 
 namespace TwigCsFixer\Rules\Whitespace;
 
-use TwigCsFixer\Rules\AbstractRule;
+use TwigCsFixer\Rules\AbstractFixableRule;
 use TwigCsFixer\Rules\ConfigurableRuleInterface;
 use TwigCsFixer\Token\Token;
 
 /**
  * Ensures that files are not indented with tabs.
  */
-final class IndentRule extends AbstractRule implements ConfigurableRuleInterface
+final class IndentRule extends AbstractFixableRule implements ConfigurableRuleInterface
 {
     public function __construct(private int $spaceRatio = 4)
     {