Simplify implementation to always collect line numbers

Remove the optional $with_line_nums parameter as suggested in review.
The function now always returns the array format with 'value' and 'line' keys,
simplifying the API and reducing conditional logic.

Co-authored-by: swissspidy <841956+swissspidy@users.noreply.github.com>

Author: Copilot

src/FileDataExtractor.php

@@ -17,12 +17,10 @@ class FileDataExtractor {
 	 *
 	 * @param string $file Path to the file.
 	 * @param array $headers List of headers, in the format array('HeaderKey' => 'Header Name').
-	 * @param bool $with_line_nums Whether to include line numbers in the returned data. Default false.
 	 *
-	 * @return array Array of file headers in `HeaderKey => Header Value` format, or
-	 *               `HeaderKey => ['value' => Header Value, 'line' => Line Number]` when $with_line_nums is true.
+	 * @return array Array of file headers in `HeaderKey => ['value' => Header Value, 'line' => Line Number]` format.
 	 */
-	public static function get_file_data( $file, $headers, $with_line_nums = false ) {
+	public static function get_file_data( $file, $headers ) {
 		// We don't need to write to the file, so just open for reading.
 		$fp = fopen( $file, 'rb' );
 
@@ -35,39 +33,33 @@ public static function get_file_data( $file, $headers, $with_line_nums = false )
 		// Make sure we catch CR-only line endings.
 		$file_data = str_replace( "\r", "\n", $file_data );
 
-		return static::get_file_data_from_string( $file_data, $headers, $with_line_nums );
+		return static::get_file_data_from_string( $file_data, $headers );
 	}
 
 	/**
 	 * Retrieves metadata from a string.
 	 *
 	 * @param string $text String to look for metadata in.
 	 * @param array $headers List of headers.
-	 * @param bool $with_line_nums Whether to include line numbers in the returned data. Default false.
 	 *
-	 * @return array Array of file headers in `HeaderKey => Header Value` format, or
-	 *               `HeaderKey => ['value' => Header Value, 'line' => Line Number]` when $with_line_nums is true.
+	 * @return array Array of file headers in `HeaderKey => ['value' => Header Value, 'line' => Line Number]` format.
 	 */
-	public static function get_file_data_from_string( $text, $headers, $with_line_nums = false ) {
+	public static function get_file_data_from_string( $text, $headers ) {
 		foreach ( $headers as $field => $regex ) {
 			if ( preg_match( '/^[ \t\/*#@]*' . preg_quote( $regex, '/' ) . ':(.*)$/mi', $text, $match, PREG_OFFSET_CAPTURE ) && $match[1][0] ) {
 				$value = static::_cleanup_header_comment( $match[1][0] );
 
-				if ( $with_line_nums ) {
-					// Calculate line number from the offset
-					$line_num          = substr_count( $text, "\n", 0, $match[0][1] ) + 1;
-					$headers[ $field ] = [
-						'value' => $value,
-						'line'  => $line_num,
-					];
-				} else {
-					$headers[ $field ] = $value;
-				}
+				// Calculate line number from the offset
+				$line_num          = substr_count( $text, "\n", 0, $match[0][1] ) + 1;
+				$headers[ $field ] = [
+					'value' => $value,
+					'line'  => $line_num,
+				];
 			} else {
-				$headers[ $field ] = $with_line_nums ? [
+				$headers[ $field ] = [
 					'value' => '',
 					'line'  => 0,
-				] : '';
+				];
 			}
 		}
 

src/IterableCodeExtractor.php

@@ -67,7 +67,7 @@ public static function fromFile( $file_or_files, Translations $translations, arr
 			}
 
 			if ( ! empty( $options['wpExtractTemplates'] ) ) {
-				$headers = FileDataExtractor::get_file_data_from_string( $text, [ 'Template Name' => 'Template Name' ], true );
+				$headers = FileDataExtractor::get_file_data_from_string( $text, [ 'Template Name' => 'Template Name' ] );
 
 				if ( ! empty( $headers['Template Name']['value'] ) ) {
 					$translation = new Translation( '', $headers['Template Name']['value'] );
@@ -89,8 +89,7 @@ public static function fromFile( $file_or_files, Translations $translations, arr
 					[
 						'Title'       => 'Title',
 						'Description' => 'Description',
-					],
-					true
+					]
 				);
 
 				if ( ! empty( $headers['Title']['value'] ) ) {

src/MakePotCommand.php

@@ -476,8 +476,7 @@ protected function get_main_file_data() {
 					array_combine(
 						$this->get_file_headers( 'theme' ),
 						$this->get_file_headers( 'theme' )
-					),
-					true
+					)
 				);
 
 				// Stop when it contains a valid Theme Name header.
@@ -499,8 +498,7 @@ protected function get_main_file_data() {
 					array_combine(
 						$this->get_file_headers( 'theme' ),
 						$this->get_file_headers( 'theme' )
-					),
-					true
+					)
 				);
 
 				// Stop when it contains a valid Theme Name header.
@@ -522,8 +520,7 @@ protected function get_main_file_data() {
 					array_combine(
 						$this->get_file_headers( 'plugin' ),
 						$this->get_file_headers( 'plugin' )
-					),
-					true
+					)
 				);
 
 				// Stop when we find a file with a valid Plugin Name header.

tests/FileDataExtractorTest.php

@@ -6,30 +6,6 @@
 use WP_CLI\Tests\TestCase;
 
 class FileDataExtractorTest extends TestCase {
-	public function test_extracts_headers_without_line_numbers() {
-		$text = <<<'TEXT'
-<?php
-/**
- * Plugin Name: My Plugin
- * Description: A test plugin
- * Version: 1.0.0
- */
-TEXT;
-
-		$headers = FileDataExtractor::get_file_data_from_string(
-			$text,
-			[
-				'Plugin Name' => 'Plugin Name',
-				'Description' => 'Description',
-				'Version'     => 'Version',
-			]
-		);
-
-		$this->assertEquals( 'My Plugin', $headers['Plugin Name'] );
-		$this->assertEquals( 'A test plugin', $headers['Description'] );
-		$this->assertEquals( '1.0.0', $headers['Version'] );
-	}
-
 	public function test_extracts_headers_with_line_numbers() {
 		$text = <<<'TEXT'
 <?php
@@ -46,8 +22,7 @@ public function test_extracts_headers_with_line_numbers() {
 				'Plugin Name' => 'Plugin Name',
 				'Description' => 'Description',
 				'Version'     => 'Version',
-			],
-			true
+			]
 		);
 
 		$this->assertIsArray( $headers['Plugin Name'] );
@@ -72,8 +47,7 @@ public function test_line_numbers_with_different_line_endings() {
 			[
 				'Plugin Name' => 'Plugin Name',
 				'Description' => 'Description',
-			],
-			true
+			]
 		);
 
 		$this->assertEquals( 'Test Plugin', $headers['Plugin Name']['value'] );
@@ -90,8 +64,7 @@ public function test_empty_headers_with_line_numbers() {
 			$text,
 			[
 				'Plugin Name' => 'Plugin Name',
-			],
-			true
+			]
 		);
 
 		$this->assertIsArray( $headers['Plugin Name'] );
@@ -116,8 +89,7 @@ public function test_theme_headers_with_line_numbers() {
 				'Description' => 'Description',
 				'Author'      => 'Author',
 				'Version'     => 'Version',
-			],
-			true
+			]
 		);
 
 		$this->assertEquals( 'My Theme', $headers['Theme Name']['value'] );
@@ -145,8 +117,7 @@ public function test_header_with_trailing_comment() {
 			$text,
 			[
 				'Plugin Name' => 'Plugin Name',
-			],
-			true
+			]
 		);
 
 		$this->assertEquals( 'My Plugin', $headers['Plugin Name']['value'] );