aboutsummaryrefslogtreecommitdiffhomepage
path: root/scripts/linters/src/Linter.php
diff options
context:
space:
mode:
Diffstat (limited to 'scripts/linters/src/Linter.php')
-rw-r--r--scripts/linters/src/Linter.php19
1 files changed, 19 insertions, 0 deletions
diff --git a/scripts/linters/src/Linter.php b/scripts/linters/src/Linter.php
new file mode 100644
index 00000000..3fb6038f
--- /dev/null
+++ b/scripts/linters/src/Linter.php
@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shirabe\Lint;
+
+interface Linter
+{
+ public function name(): string;
+
+ /**
+ * @param list<string> $excludes root-relative paths to skip
+ * @return list<string> formatted violation lines; empty when the linter passes
+ */
+ public function check(string $rootDir, array $excludes): array;
+
+ /** Printed once, above the violation list, when violations are found. */
+ public function failureIntro(): string;
+}