Add check name in results

WordPress / plugin-check

A repository for the new Plugin Check plugin from the WordPress Performance and Plugins Team.

https://wordpress.org/plugins/plugin-check/

GNU General Public License v2.0

198 stars 39 forks source link

Add check name in results #376

Closed ernilambar closed 5 months ago

ernilambar commented 6 months ago

In this PR:

Every Check is assumed to have a name. So get_name() has been added to interface Check.
check has been added to final class Check_Result.
includes/Traits/Amend_Check_Result.php - Methods are updated to accomodate newly added check field.
Late_Escaping_Check.php: get_name() method is implemented. Eg:

public function get_name() {
   return 'late_escaping';
}

Output:

ernilambar commented 6 months ago

Requesting for feedback whether this approach is good or not.

cc: @swissspidy @felixarntz @mukeshpanchal27

felixarntz commented 5 months ago

@ernilambar I like the idea of optionally supporting the inclusion of the check identifier. That said, I think we'll need to carefully think about how to implement that change. Preferably, this should be handled in a central place, without having to define the check identifiers as both array keys and in each class.

ernilambar commented 5 months ago

@felixarntz May be this approach is better. Please review it. https://github.com/WordPress/plugin-check/pull/380