[Update] Documentation for sniff WordPress.Files.FilesName

[jasonkenison]

Related to #1722
Continuing updates from #2492

1. Grouped all checks into individual standards.
2. Included additional standards not previously included
3. Added more check valid and invalid examples

Closes #2492

[rodrigoprimo]

Thanks for working on this PR, @jasonkenison! I left some comments with suggestions. Let me know if you have any questions.

[rodrigoprimo]

Considering the invalid example related to this one, I believe the valid example should separate the two words with a hyphen, no? This would also fix the error in CI that is a false positive in my opinion, as ome is incorrectly being flagged as a typo.

Suggested change

	<em>s</em>ome<em>f</em>ile.inc
	some<em>-</em>file.inc

[jasonkenison]

@rodrigoprimo these were tricky, was trying to highlight where non-lowercase letters were used. To get past the spelling error, it now highlights <em>Some</em> as a complete word instead of just the character.

[rodrigoprimo]

For the valid examples of the first two errors, as they check if the whole name matches what is expect, maybe we can highlight the full name (excluding the period and the file extension)?

For the third error, I think it is better to highlight just -template as it is already the case.

For the invalid examples, I think you could highlight just the part that is causing the error.

[rodrigoprimo]

@jasonkenison, I was just wondering if you'll have a chance to finish this off in the near future. It would be great if this PR could be included in the next WPCS release.

If you haven't got time or lost interest, please let us know and we'll see if we can find someone to take over. Thanks!

[rodrigoprimo]

@rodrigoprimo I'm not sure how to solve this one, but am happy to discuss or try recommendations.

Regarding your question here, this is more or less what I have in mind. What do you think?

Suggested change

	<code_comparison>
	<code title="Valid: File name matches prefix and class.">
	<![CDATA[
	<em>class-bulk-updater</em>.php // For a class named `Bulk_Updater`.
	]]>
	</code>
	<code title="Invalid: File name missing prefix or class.">
	<![CDATA[
	class<em>.</em>bulk-updater.php
	<em>bulk-updater</em>.php
	bulk-updater<em>-class</em>.php
	]]>
	</code>
	</code_comparison>
	<code_comparison>
	<code title="Valid: File name matches class name with proper prefix.">
	<![CDATA[
	<em>class-bulk-updater</em>.php // `Bulk_Updater`.
	<em>class-user-profile</em>.php // `User_Profile`.
	<em>class-export-data</em>.php // `Export_Data`.
	]]>
	</code>
	<code title="Invalid: File name does not match class name or the prefix is incorrect.">
	<![CDATA[
	class-<em>update-in-bulk</em>.php // `Bulk_Updater`.
	<em></em>user-profile.php // `User_Profile`.
	<em>class.</em>export-data.php // `Export_Data`.
	]]>
	</code>
	</code_comparison>

[jasonkenison]

@rodrigoprimo Change made in the latest commit

[rodrigoprimo]

@jasonkenison, I reacted with 👍 in the last comment of all the conversations where you already addressed my suggestion. When you have a moment, could you please resolve those? I also replied to your question and provided an example.

I believe there is still one comment that was not addressed: #2590 (comment)

Thanks for your contributions!