Merge pull request #686 from oallain/feature/twigcs-exclude

twigcs exclude subfolders
phpro · Mar 19, 2020 · b835400 · b835400
2 parents d1731bc + e1049f5
commit b835400
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 0 deletions.
diff --git a/doc/tasks/twigcs.md b/doc/tasks/twigcs.md
@@ -21,6 +21,7 @@ parameters:
             severity: 'warning'
             ruleset: 'FriendsOfTwig\Twigcs\Ruleset\Official'
             triggered_by: ['twig']
+            exclude: []
 ```
 
 **path**
@@ -47,3 +48,9 @@ Ruleset used, default ruleset is based on [official one from twig](https://twig.
 *Default: [twig]*
 
 This option will specify which file extensions will trigger this task.
+
+**exclude**
+
+*Default: []*
+
+This option will specify which relative subfolders or files will be exclude to this task.
diff --git a/src/Task/TwigCs.php b/src/Task/TwigCs.php
@@ -21,9 +21,11 @@ public static function getConfigurableOptions(): OptionsResolver
             'severity' => 'warning',
             'ruleset' => 'FriendsOfTwig\Twigcs\Ruleset\Official',
             'triggered_by' => ['twig'],
+            'exclude' => [],
         ]);
 
         $resolver->addAllowedTypes('path', ['string']);
+        $resolver->addAllowedTypes('exclude', ['array']);
         $resolver->addAllowedTypes('severity', ['string']);
         $resolver->addAllowedTypes('ruleset', ['string']);
         $resolver->addAllowedTypes('triggered_by', ['array']);
@@ -52,6 +54,10 @@ public function run(ContextInterface $context): TaskResultInterface
         $arguments->addOptionalArgument('--ruleset=%s', $config['ruleset']);
         $arguments->addOptionalArgument('--ansi', true);
 
+        // removes all NULL, FALSE and Empty Strings
+        $exclude = array_filter($config['exclude'], 'strlen');
+        $arguments->addArgumentArray('--exclude=%s', $exclude);
+
         $process = $this->processBuilder->buildProcess($arguments);
         $process->run();
 

diff --git a/test/Unit/Task/TwigCsTest.php b/test/Unit/Task/TwigCsTest.php
@@ -29,6 +29,7 @@ public function provideConfigurableOptions(): iterable
                 'severity' => 'warning',
                 'ruleset' => 'FriendsOfTwig\Twigcs\Ruleset\Official',
                 'triggered_by' => ['twig'],
+                'exclude' => [],
             ]
         ];
     }
@@ -116,5 +117,21 @@ public function provideExternalTaskRuns(): iterable
                 '--ansi',
             ]
         ];
+
+        yield 'exclude' => [
+            [
+                'exclude' => ['src/', 'test/', null, '', false],
+            ],
+            $this->mockContext(RunContext::class, ['hello.twig', 'hello2.twig']),
+            'twigcs',
+            [
+                '.',
+                '--severity=warning',
+                '--ruleset=FriendsOfTwig\Twigcs\Ruleset\Official',
+                '--ansi',
+                '--exclude=src/',
+                '--exclude=test/',
+            ]
+        ];
     }
 }