Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Check: Check the readme plugin name has the correct convention #653

Closed
davidperezgar opened this issue Sep 20, 2024 · 4 comments
Closed
Assignees
Labels
Checks Audit/test of the particular part of the plugin [Team] Plugin Review Issues owned by Plugin Review Team

Comments

@davidperezgar
Copy link
Member

It the Plugin name in the readme header has different syntax, it should give you an error.

For example:
== Plugin Name ==

It should give you an error as it has incorrect syntax. It needs === in both sides of the plugin name.

@davidperezgar davidperezgar added Checks Audit/test of the particular part of the plugin [Team] Plugin Review Issues owned by Plugin Review Team labels Sep 20, 2024
@davidperezgar davidperezgar self-assigned this Sep 20, 2024
@swissspidy
Copy link
Member

Isn't the readme parser already handling this kinda stuff? From what I can see it's pretty forgiving and doesn't actually care if for example the === on the right side is missing. See https://github.com/afragen/wordpress-plugin-readme-parser/blob/c3758599348148be684b3c4ad1105d09b6230d51/class-parser.php#L239-L269

@davidperezgar
Copy link
Member Author

Yes, I use the validator and it works fine. But Should not warn that as a good practice?

@swissspidy
Copy link
Member

If you think the parser should trigger a warning for this, I recommend creating a Meta Trac ticket to update the parser.

@davidperezgar
Copy link
Member Author

Ok. I've made an issue in the parser. Let's close this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Checks Audit/test of the particular part of the plugin [Team] Plugin Review Issues owned by Plugin Review Team
Projects
None yet
Development

No branches or pull requests

2 participants