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.

Sign up for GitHub

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

Add documentation for FileName sniff #2492

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
+36 −0
Open

Add documentation for FileName sniff #2492

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6d1f6bb
Add: documentation for FileName sniff
Nic-Sevic Sep 17, 2024
4f4f541
fix: syntax issues
Nic-Sevic Sep 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions WordPress/Docs/Files/FileNameStandard.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<?xml version="1.0"?>
<documentation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://phpcsstandards.github.io/PHPCSDevTools/phpcsdocs.xsd"
title="File Name Standards"
>
<standard>
<![CDATA[
Ensures that file names meet the following standards:
- Filenames should be all lowercase with hyphens separating words.
- Class file names should be based on the class name with "class-" prepended.
- Files in `wp-includes` containing template tags should end in `-template`.

If `$is_theme` property is set to `true` certain theme specific exceptions are made for underscores.
]]>
</standard>
<code_comparison>
<code title="Valid: All lowercase with only hyphens as word separators and proper use of prefix/suffix.">
<![CDATA[
taxonomy<em>-</em>my<em>-</em>term.inc
<em>s</em>ome<em>f</em>ile.inc
<em>class</em>-testsample.inc
other<em>-</em>punctuation.inc
general<em>-template</em>.php
]]>
</code>
<code title="Invalid: Use of other punctuation, uppercase, or missing prefix/suffix.">
<![CDATA[
taxonomy-my<em>_</em>term.inc.
<em>S</em>ome<em>F</em>ile.inc
<em>testsample</em>-unit-2.inc
other<em>+</em>punctuation<em>#</em>.inc
<em>general</em>.php
]]>
</code>
</code_comparison>
</documentation>
Loading