Update isOnExcludeList defaults to root dir

Author: driftingly

src/Commands/BaseCommand.php

@@ -94,14 +94,15 @@ protected function isExcluded(string $filepath): bool
         return false;
     }
 
-    protected function isBlacklisted($filepath)
+    protected function isOnExcludeList($filepath)
     {
         $DS = DIRECTORY_SEPARATOR;
+        $root = realpath($this->cwd ?? getcwd());
 
-        return strpos($filepath, 'vendor') !== false
-            || strpos($filepath, 'node_modules') !== false
+        return strpos($filepath, "{$root}{$DS}vendor{$DS}") === 0
+            || strpos($filepath, "{$root}{$DS}node_modules{$DS}") === 0
+            || strpos($filepath, "{$root}{$DS}bootstrap{$DS}") === 0
             || strpos($filepath, "storage{$DS}framework{$DS}views") !== false
-            || strpos($filepath, 'bootstrap') !== false
             || $this->isExcluded($filepath);
     }
 }

src/Commands/FormatCommand.php

@@ -49,7 +49,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $fileOrDirectory = $this->resolveFileOrDirectory($input->getArgument('file or directory'));
         $finalResponseCode = self::SUCCESS;
 
-        if ($this->isBlacklisted($fileOrDirectory)) {
+        if ($this->isOnExcludeList($fileOrDirectory)) {
             return self::SUCCESS;
         }
 
@@ -84,7 +84,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
     private function formatFile(InputInterface $input, OutputInterface $output, $file)
     {
-        if ($this->isBlacklisted($file)) {
+        if ($this->isOnExcludeList($file)) {
             return self::SUCCESS;
         }
 

src/Commands/LintCommand.php

@@ -58,7 +58,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
         $fileOrDirectory = $this->resolveFileOrDirectory($input->getArgument('file or directory'));
         $finalResponseCode = self::NO_LINTS_FOUND_OR_SUCCESS;
 
-        if ($this->isBlacklisted($fileOrDirectory)) {
+        if ($this->isOnExcludeList($fileOrDirectory)) {
             return self::NO_LINTS_FOUND_OR_SUCCESS;
         }
 
@@ -109,7 +109,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
     private function lintFile(InputInterface $input, OutputInterface $output, $file)
     {
-        if ($this->isBlacklisted($file)) {
+        if ($this->isOnExcludeList($file)) {
             return self::NO_LINTS_FOUND_OR_SUCCESS;
         }
 

tests/ExcludedPathTest.php

@@ -0,0 +1,93 @@
+<?php
+
+namespace Tests;
+
+use PHPUnit\Framework\TestCase;
+use ReflectionMethod;
+use Tighten\TLint\Commands\LintCommand;
+
+class ExcludedPathTest extends TestCase
+{
+    private string $root;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->root = realpath(sys_get_temp_dir());
+    }
+
+    private function isOnExcludeList(string $filepath): bool
+    {
+        $command = new LintCommand(sys_get_temp_dir());
+
+        $method = new ReflectionMethod($command, 'isOnExcludeList');
+
+        return $method->invoke($command, $filepath);
+    }
+
+    /** @test */
+    public function it_excludes_root_vendor_directory()
+    {
+        $DS = DIRECTORY_SEPARATOR;
+
+        $this->assertTrue($this->isOnExcludeList("{$this->root}{$DS}vendor{$DS}league{$DS}commonmark{$DS}src{$DS}File.php"));
+    }
+
+    /** @test */
+    public function it_allows_vendor_views_directory()
+    {
+        $DS = DIRECTORY_SEPARATOR;
+
+        $this->assertFalse($this->isOnExcludeList("{$this->root}{$DS}resources{$DS}views{$DS}vendor{$DS}mail{$DS}html{$DS}header.blade.php"));
+    }
+
+    /** @test */
+    public function it_does_not_exclude_files_containing_vendor_in_name()
+    {
+        $DS = DIRECTORY_SEPARATOR;
+
+        $this->assertFalse($this->isOnExcludeList("{$this->root}{$DS}app{$DS}Http{$DS}Controllers{$DS}VendorController.php"));
+    }
+
+    /** @test */
+    public function it_excludes_root_node_modules_directory()
+    {
+        $DS = DIRECTORY_SEPARATOR;
+
+        $this->assertTrue($this->isOnExcludeList("{$this->root}{$DS}node_modules{$DS}lodash{$DS}index.js"));
+    }
+
+    /** @test */
+    public function it_does_not_exclude_files_containing_node_modules_in_name()
+    {
+        $DS = DIRECTORY_SEPARATOR;
+
+        $this->assertFalse($this->isOnExcludeList("{$this->root}{$DS}app{$DS}Http{$DS}Controllers{$DS}NodeModulesController.php"));
+    }
+
+    /** @test */
+    public function it_excludes_root_bootstrap_directory()
+    {
+        $DS = DIRECTORY_SEPARATOR;
+
+        $this->assertTrue($this->isOnExcludeList("{$this->root}{$DS}bootstrap{$DS}app.php"));
+    }
+
+    /** @test */
+    public function it_does_not_exclude_files_containing_bootstrap_in_name()
+    {
+        $DS = DIRECTORY_SEPARATOR;
+
+        $this->assertFalse($this->isOnExcludeList("{$this->root}{$DS}app{$DS}Http{$DS}Controllers{$DS}BootstrapController.php"));
+        $this->assertFalse($this->isOnExcludeList("{$this->root}{$DS}resources{$DS}views{$DS}bootstrap-layout.blade.php"));
+    }
+
+    /** @test */
+    public function it_excludes_storage_framework_views_directory()
+    {
+        $DS = DIRECTORY_SEPARATOR;
+
+        $this->assertTrue($this->isOnExcludeList("{$this->root}{$DS}storage{$DS}framework{$DS}views{$DS}cached.php"));
+    }
+}

tlint.json

@@ -0,0 +1,3 @@
+{
+    "excluded": ["tests/fixtures"]
+}