Merge pull request #525 from ernilambar/524-readme-file

Co-authored-by: ernilambar <[email protected]>
Co-authored-by: swissspidy <[email protected]>

includes/Traits/Find_Readme.php

@@ -25,7 +25,7 @@ trait Find_Readme {
 	 */
 	protected function filter_files_for_readme( array $files, $plugin_relative_path ) {
 		// Find the readme file.
-		$readme_list = preg_grep( '/readme\.(txt|md)$/i', $files );
+		$readme_list = preg_grep( '/\/readme\.(txt|md)$/i', $files );
 
 		// Filter the readme files located at root.
 		$potential_readme_files = array_filter(

tests/phpunit/testdata/plugins/test-plugin-plugin-readme-errors-invalid-readme/load.php

@@ -0,0 +1,16 @@
+<?php
+/**
+ * Plugin Name: Test Plugin Readme Errors (invalid readme)
+ * Plugin URI: https://github.com/WordPress/plugin-check
+ * Description: Test plugin for the Readme check.
+ * Requires at least: 6.0
+ * Requires PHP: 5.6
+ * Version: 1.0.0
+ * Author: WordPress Performance Team
+ * Author URI: https://make.wordpress.org/performance/
+ * License: GPLv2 or later
+ * License URI: https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
+ * Text Domain: test-plugin-check-errors
+ *
+ * @package test-plugin-check-errors
+ */

tests/phpunit/tests/Checker/Checks/Plugin_Readme_Check_Tests.php

@@ -31,6 +31,25 @@ public function test_run_with_errors_no_readme() {
 		$this->assertEquals( 'no_plugin_readme', $warnings['readme.txt'][0][0][0]['code'] );
 	}
 
+	public function test_run_with_errors_invalid_readme_files() {
+		$readme_check  = new Plugin_Readme_Check();
+		$check_context = new Check_Context( UNIT_TESTS_PLUGIN_DIR . 'test-plugin-plugin-readme-errors-invalid-readme/load.php' );
+		$check_result  = new Check_Result( $check_context );
+
+		$readme_check->run( $check_result );
+
+		$warnings = $check_result->get_warnings();
+
+		$this->assertNotEmpty( $warnings );
+		$this->assertArrayHasKey( 'readme.txt', $warnings );
+		$this->assertEquals( 1, $check_result->get_warning_count() );
+
+		$this->assertArrayHasKey( 0, $warnings['readme.txt'] );
+		$this->assertArrayHasKey( 0, $warnings['readme.txt'][0] );
+		$this->assertArrayHasKey( 'code', $warnings['readme.txt'][0][0][0] );
+		$this->assertSame( 'no_plugin_readme', $warnings['readme.txt'][0][0][0]['code'] );
+	}
+
 	public function test_run_with_errors_invalid_name() {
 		$readme_check  = new Plugin_Readme_Check();
 		$check_context = new Check_Context( UNIT_TESTS_PLUGIN_DIR . 'test-plugin-plugin-readme-errors-invalid-name/load.php' );