WatcherFactory: Add support for exclude and ignore options. (#116)

Author: iandunn

README.md

@@ -124,9 +124,18 @@ watch:
   directories:
     - src
     - tests
+  exclude:
+    - lib
   fileMask: '*.php'
+  ignoreDotFiles: true
+  ignoreVCS: true
+  ignoreVCSIgnored: false
 ```
 
+See [the documentation for Finder](https://symfony.com/doc/current/components/finder.html) for more details.
+
+If you experience performance delays with large repositories, try adding `exclude` entries for any large subdirectories that you don't need to watch. Enabling the `ignore...` options can also be helpful. It's also important to ensure you're also using the `'*.php'` file mask.
+
 ### Desktop notifications
 
 By default the tool will display desktop notifications whenever the tests pass or fail. If you want to disable certain desktop notifications update `.phpunit-watcher.yml` by adding a `notifications` key.

src/WatcherFactory.php

@@ -19,10 +19,12 @@ public static function create(array $options = []): array
         }
 
         $finder = (new Finder())
-            ->ignoreDotFiles(false)
-            ->ignoreVCS(false)
+            ->ignoreDotFiles($options['watch']['ignoreDotFiles'])
+            ->ignoreVCS($options['watch']['ignoreVCS'])
+            ->ignoreVCSIgnored($options['watch']['ignoreVCSIgnored'])
             ->name($options['watch']['fileMask'])
             ->files()
+            ->exclude($options['watch']['exclude'])
             ->in($options['watch']['directories']);
 
         $watcher = new Watcher($finder, $options);
@@ -39,6 +41,10 @@ public static function getDefaultOptions(): array
                     'src',
                     'tests',
                 ],
+                'exclude' => [],
+                'ignoreDotFiles' => false,
+                'ignoreVCS' => false,
+                'ignoreVCSIgnored' => false,
                 'fileMask' => '*.php',
             ],
             'notifications' => [