better help page (#145)

Author: staabm

bin/phpstan-baseline-filter.php

@@ -34,7 +34,13 @@
     exit(254);
 }
 
-$filterConfig = \staabm\PHPStanBaselineAnalysis\FilterConfig::fromArgs($argv[2]);
+try {
+    $filterConfig = \staabm\PHPStanBaselineAnalysis\FilterConfig::fromArgs($argv[2]);
 
-$exitCode = $app->start($argv[1], $filterConfig);
-exit($exitCode);
+    $exitCode = $app->start($argv[1], $filterConfig);
+    exit($exitCode);
+} catch (\Exception $e) {
+    echo 'ERROR: '. $e->getMessage().PHP_EOL.PHP_EOL;
+    $app->help();
+    exit(254);
+}

lib/FilterApplication.php

@@ -51,7 +51,10 @@ public function start(string $glob, FilterConfig $filterConfig): int
      */
     public function help(): void
     {
-        printf('USAGE: phpstan-baseline-filter <GLOB-PATTERN> [--exclude=<FILTER-KEY>,...] [--include=<FILTER-KEY>,...]');
+        echo 'USAGE: phpstan-baseline-filter <GLOB-PATTERN> [--exclude=<FILTER-KEY>,...] [--include=<FILTER-KEY>,...]'.PHP_EOL.PHP_EOL;
+        printf('valid FILTER-KEYs: %s', implode(', ', ResultPrinter::getFilterKeys()));
+
+        echo PHP_EOL;
     }
 
     /**

lib/FilterConfig.php

@@ -24,14 +24,14 @@ static public function fromArgs(string $args): self {
             if (str_starts_with($arg, '--exclude=')) {
                 foreach(explode(',', substr($arg, 10)) as $key) {
                     if (!ResultPrinter::isFilterKey($key)) {
-                        throw new \Exception("Invalid key: $key");
+                        throw new \Exception("Invalid filter key: $key");
                     }
                     $config->excluded[] = $key;
                 }
             } else if (str_starts_with($arg, '--include=')) {
                 foreach(explode(',', substr($arg, 10)) as $key) {
                     if (!ResultPrinter::isFilterKey($key)) {
-                        throw new \Exception("Invalid key: $key");
+                        throw new \Exception("Invalid filter key: $key");
                     }
                     $config->included[] = $key;
                 }

lib/ResultPrinter.php

@@ -32,16 +32,22 @@ final class ResultPrinter {
      */
     public static function isFilterKey(string $filterString): bool
     {
-        $keys = [
+
+        return in_array($filterString, self::getFilterKeys(), true);
+    }
+
+    /**
+     * @return array<self::KEY_*>
+     */
+    public static function getFilterKeys(): array {
+        return [
             self::KEY_CLASSES_COMPLEXITY,
             self::KEY_DEPRECATIONS,
             self::KEY_INVALID_PHPDOCS,
             self::KEY_UNKNOWN_TYPES,
             self::KEY_ANONYMOUS_VARIABLES,
             self::KEY_UNUSED_SYMBOLS,
         ];
-
-        return in_array($filterString, $keys, true);
     }
 
     /**