Try: Add simplified readme validator

[carolinan]

Fixes #375

This check and the accompanying parser is copied from the plugin readme validator.

It is more limited than the plugin readme validator, and it does not work for themes that are in sub folders.
The subfolder issue may be solved by #370. Untested.

How to test:

1. Test with a theme that is missing a readme.txt and readme.md
2. Confirm that the error about the missing readme is displaying.
3. Test with a theme with missing headers in the readme.
4. Confirm that the warnings are displaying.
5. Test with a theme with incorrect headers in the readme.
6. Confirm that the warnings are displaying.

[carolinan]

The report:

[TeBenachi]

Step 2. Tested and can confirm the missing error.

Step 4. Tested and confirmed.

Step 6. Tested and confirmed. Screenshot attached.

One thing I noticed. There was no warning when I added multiple contributors.

[carolinan]

Thank you.
Yes good point about the contributors. I left that out since the Theme Check plugin can not verify the user name (which the plugin readme validator can).

[kafleg]

Test with a theme that is missing a readme.txt and readme.md
Tested and worked. Also, i liked this REQUIRED: Found a copy of Underscores. See README.md. Learn how to update the files for your own theme. If there is README.md file of default underscores found.

Confirm that the error about the missing readme is displaying.
Confirmed - REQUIRED: The readme file is missing.

Test with a theme with missing headers in the readme.
Confirmed.

README WARNING: The Tested up to field is missing from the readme.
README WARNING: The Requires at least field is missing from the readme.
README WARNING: The Requires PHP field is missing from the readme.
README WARNING: The License field is missing from the readme.
README WARNING: The License URI field is missing from the readme.
README WARNING: The Contributors field is missing from the readme.

Confirm that the warnings are displaying.
Done, please check above.

Test with a theme with incorrect headers in the readme.
Only one issue shown, README WARNING: The Requires at least field in the readme was ignored. This field should only contain a valid WordPress version such as 0.0 or -0.1.

my readme header is like below,

Contributors: templatesellxyz
Tags: red, cat, dog
Requires at least: 22.5
Requires PHP: 9.0
Tested up to: 4.3
Stable tag: 1.2.9
License: License.txt
License URI: wordpress.org

Confirm that the warnings are displaying.
Check above.

On a side note, is this INFO necessary?

README INFO: No == Frequently Asked Questions == section was found in the readme.
README INFO: No == Description == section was found in the readme.
README INFO: No == Changelog == section was found in the readme.

[carolinan]

The requires at least is compared to $latest_wordpress_version = '5.8'; so 22.5 should fail. How can we document this?
This hard coded value is problematic, but there is no constant with the latest WordPress version that can be used.

[carolinan]

The info does make it noisy. My thought was to:
-Match the plugin validator info
-Prepare for when the info is shown in the directory.

But if you prefer it can be removed and reconsidered once there are solid plans to show it in the directory.

[TeBenachi]

How about something like this?

The Requires at least field requires the least WordPress version. This field should only contain a valid WordPress version such as 0.0 or 0.1.

I didn’t notice it yesterday but there is “ - " (minus sign) in the Requires at least warning message?

[carolinan]

Yeah I think it is broken. I'd like to compare with the live plugin validator.

[kafleg]

Looks good.

README WARNING: The Contributors field should only contain one WordPress.org username. Remember that usernames are case-sensitive.

[kafleg]

protected $latest_wordpress_version = '5.8';

We need to make it dynamic.

[TeBenachi]

Contributors: Ginger Snap

When I added 2 users without “,” comma between them, the check returned no error.
I know most of the people use “,” comma to separate strings but should we also add a check in case?

Contributors: Ginger, Snap worked perfectly.

[carolinan]

I have not used the sniffer for so long, that I forgot that it checks for this:
https://github.com/WPTT/theme-sniffer/blob/development/src/sniffs/readme/class-contributors.php

[carolinan]

protected $latest_wordpress_version = '5.8';

We need to make it dynamic.

But how?

[TeBenachi]

I have not used the sniffer for so long, that I forgot that it checks for this:
https://github.com/WPTT/theme-sniffer/blob/development/src/sniffs/readme/class-contributors.php

Thanks for the link. I got the contributor validation working based on the sniffer. It’s silly but I don’t know how to create a branch off a branch. Any suggestions on how to proceed.

[kafleg]

@dd32 What will happen if my local WordPress version is less than the current version?

[kafleg]

No notice is shown in this case, Tested up to: 5.9

But if we go above 6.0 then it shows, README WARNING: The Tested up to field in the readme was ignored. This field should only contain a valid WordPress version such as 5.8 or 5.9.

If the WordPress version will be higher than 5.9, then do we need to reset the version again?

Nothing shows for, Requires PHP: 22.5, here 22.5 is just a testing value.

Rest of the things looks fine to me.

[kafleg]

I found one thing,
If there is space in readme header items, then it shows the errors.

And errors list,

Once I removed that space, only the error of contributors is displayed.

[carolinan]

If the WordPress version will be higher than 5.9, then do we need to reset the version again?

We would have had to but Dion's update solves that.

[kafleg]

If the WordPress version will be higher than 5.9, then do we need to reset the version again?

We would have had to but Dion's update solves that.

Okay, thanks for the update.

Any idea how to fix the readme issues with spacing?

[carolinan]

I have not used the sniffer for so long, that I forgot that it checks for this:
https://github.com/WPTT/theme-sniffer/blob/development/src/sniffs/readme/class-contributors.php

Thanks for the link. I got the contributor validation working based on the sniffer. It’s silly but I don’t know how to create a branch off a branch. Any suggestions on how to proceed.

I am not sure either 😊 Maybe we need to do it in two steps and merge this one first?

[carolinan]

Any idea how to fix the readme issues with spacing?

I'll see if I can make it remove blank lines from the header, but the warning is also correct, the blank line must not be there.

[carolinan]

8e696d2 Checks if the name in the readme matches the theme name, if not, error.
Updates the $latest_wordpres_version variable.
Removes empty lines to prevent errors with the check.

To avoid reading the wrong readme file if there is more than one readme, this PR needs to be tested together with
#370.

[kafleg]

Theme readme file,

But there is no error/notice shown.

I checked again with removing other,

Now, I can see an error notice for Tested up to, Requires at least and Requires PHP.

[carolinan]

Does the license and license URI have a single space after the colon?

[kafleg]

Requires at least: 5.5
Tested up to: 5.8
Requires PHP: 7.4
Stable tag: 1.0.0
License:
License URI:

Tested with both adding space, removing space, double space. The result is same.

[carolinan]

I think I found the bug where it does not show that the license is missing, but I need your full readme file to confirm.

It is not only checking the file header, so if the words "License: blah blah" are elsewhere in the readme file, like for an asset, it will use that.