Merge pull request #1029 from JustMisha/extra-line-in-excerpt-can-be-…

…set-via-cli-arg Added the option to the command line to set the number of extra lines in code snippets
phpmd · Sep 15, 2023 · 86c76e4 · 86c76e4
2 parents 63ca48a + c4484f1
commit 86c76e4
Show file tree

Hide file tree

Showing 6 changed files with 51 additions and 5 deletions.
diff --git a/README.rst b/README.rst
@@ -165,6 +165,7 @@ Command line options
 
   - ``--color`` - enable color in output, for instance text renderer
     will show rule name in yellow and error description in red.
+  - ``--extra-line-in-excerpt`` - specify how many extra lines are added to a code snippet in html format
 
   An example command line: ::
 

diff --git a/src/main/php/PHPMD/Renderer/HTMLRenderer.php b/src/main/php/PHPMD/Renderer/HTMLRenderer.php
@@ -64,6 +64,20 @@ class HTMLRenderer extends AbstractRenderer
 
     protected static $compiledHighlightRegex = null;
 
+    /**
+     * Specify how many extra lines are added to a code snippet
+     * By default 2
+     * @var int
+     */
+    protected $extraLineInExcerpt = 2;
+
+    public function __construct($extraLineInExcerpt = null)
+    {
+        if ($extraLineInExcerpt && is_int($extraLineInExcerpt)) {
+            $this->extraLineInExcerpt = $extraLineInExcerpt;
+        }
+    }
+
     /**
      * This method will be called on all renderers before the engine starts the
      * real report processing.
@@ -362,7 +376,7 @@ class='info-lnk blck'
             $excerpt = self::getLineExcerpt(
                 $violation->getFileName(),
                 $violation->getBeginLine(),
-                2
+                $this->extraLineInExcerpt
             );
 
             foreach ($excerpt as $line => $code) {

diff --git a/src/main/php/PHPMD/TextUI/CommandLineOptions.php b/src/main/php/PHPMD/TextUI/CommandLineOptions.php
@@ -211,6 +211,12 @@ class CommandLineOptions
      */
     protected $colored = false;
 
+    /**
+     * Specify how many extra lines are added to a code snippet
+     * @var int|null
+     */
+    protected $extraLineInExcerpt;
+
     /**
      * Constructs a new command line options instance.
      *
@@ -327,6 +333,9 @@ public function __construct(array $args, array $availableRuleSets = array())
                     preg_match('(^\-\-reportfile\-(checkstyle|github|gitlab|html|json|sarif|text|xml)$)', $arg, $match);
                     $this->reportFiles[$match[1]] = array_shift($args);
                     break;
+                case '--extra-line-in-excerpt':
+                    $this->extraLineInExcerpt = (int)array_shift($args);
+                    break;
                 default:
                     $arguments[] = $arg;
                     break;
@@ -577,6 +586,15 @@ public function ignoreViolationsOnExit()
         return $this->ignoreViolationsOnExit;
     }
 
+    /**
+     * Specify how many extra lines are added to a code snippet
+     *
+     * @return int|null
+     */
+    public function extraLineInExcerpt()
+    {
+        return $this->extraLineInExcerpt;
+    }
     /**
      * Creates a report renderer instance based on the user's command line
      * argument.
@@ -686,7 +704,7 @@ protected function createGitHubRenderer()
      */
     protected function createHtmlRenderer()
     {
-        return new HTMLRenderer();
+        return new HTMLRenderer($this->extraLineInExcerpt);
     }
 
     /**
@@ -801,7 +819,9 @@ public function usage()
             'to the first ruleset file location' . \PHP_EOL .
             '--update-baseline: will remove any non-existing violations from the phpmd.baseline.xml' . \PHP_EOL .
             '--baseline-file: a custom location of the baseline file' . \PHP_EOL .
-            '--color: enable color in output' . \PHP_EOL;
+            '--color: enable color in output' . \PHP_EOL .
+            '--extra-line-in-excerpt: Specify how many extra lines are added ' .
+            'to a code snippet in html format' . \PHP_EOL;
     }
 
     /**

diff --git a/src/test/php/PHPMD/AbstractTest.php b/src/test/php/PHPMD/AbstractTest.php
@@ -611,7 +611,7 @@ protected function getRuleViolationMock(
     }
 
     /**
-     * Creates a mocked rul violation instance.
+     * Creates a mocked rule violation instance.
      *
      * @param string $file
      * @param string $message

diff --git a/src/test/php/PHPMD/Renderer/HTMLRendererTest.php b/src/test/php/PHPMD/Renderer/HTMLRendererTest.php
@@ -49,7 +49,8 @@ public function testRendererCreatesExpectedHtmlTableRow()
             ->method('getRuleViolations')
             ->will($this->returnValue(new \ArrayIterator($violations)));
 
-        $renderer = new HTMLRenderer();
+        $extraLineInExcerpt = 2;
+        $renderer = new HTMLRenderer($extraLineInExcerpt);
         $renderer->setWriter($writer);
 
         $renderer->start();

diff --git a/src/test/php/PHPMD/TextUI/CommandLineOptionsTest.php b/src/test/php/PHPMD/TextUI/CommandLineOptionsTest.php
@@ -726,6 +726,16 @@ public function testGetReportFiles(array $options, array $expected)
         $this->assertEquals($expected, $opts->getReportFiles());
     }
 
+    /**
+     * @return void
+     */
+    public function testCliOptionExtraLineInExcerptShouldBeWithNumber()
+    {
+        $args = array(__FILE__, __FILE__, 'text', 'codesize', '--extra-line-in-excerpt', '5');
+        $opts = new CommandLineOptions($args);
+        static::assertSame(5, $opts->extraLineInExcerpt());
+    }
+
     public function dataProviderGetReportFiles()
     {
         return array(