Skip to content

[Documentation] Squiz: Superfluous Whitespace #352

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

Merged
merged 5 commits into from
Feb 27, 2024
Merged

[Documentation] Squiz: Superfluous Whitespace #352

Changes from 2 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1238c8a
Docs: add documentation for Squiz.WhiteSpace.SuperfluousWhitespace
jaymcp Feb 5, 2024
aa088bd
Docs: improve documentation for Squiz.WhiteSpace.SuperfluousWhitespace
jaymcp Feb 23, 2024
fe18bcb
Docs: fix typo in Squiz.WhiteSpace.SuperfluousWhitespace code example
jaymcp Feb 26, 2024
a584db2
Docs: rewrite incorrect code example for Squiz.WhiteSpace.Superfluous…
jaymcp Feb 26, 2024
c593d61
Squiz/SuperfluousWhitespace: tiny tweak
jrfnl Feb 27, 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
99 changes: 99 additions & 0 deletions src/Standards/Squiz/Docs/WhiteSpace/SuperfluousWhitespaceStandard.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
<documentation title="Superfluous Whitespace">
<standard>
<![CDATA[
There should be no superfluous whitespace at the start of a file.
]]>
</standard>
<code_comparison>
<code title="Valid: No whitespace preceding first content in file.">
<![CDATA[<?php
echo 'opening PHP tag at start of file';
]]>
</code>
<code title="Invalid: Whitespace used before content in file.">
<![CDATA[
<em> </em>
<?php
echo 'whitespace before opening PHP tag';
]]>
</code>
</code_comparison>
<standard>
<![CDATA[
There should be no trailing whitespace at the end of lines.
]]>
</standard>
<code_comparison>
<code title="Valid: No whitespace found at end of line.">
<![CDATA[
echo 'semicolon followed by new linechar';
]]>
</code>
<code title="Invalid: Whitespace found at end of line.">
<![CDATA[
echo 'trailing spaces after semicolon';<em> </em>
]]>
</code>
</code_comparison>
<standard>
<![CDATA[
There should be no more than one consecutive blank newline in functions.
]]>
</standard>
<code_comparison>
<code title="Valid: Functions do not contain multiple empty lines in a row.">
<![CDATA[
function myFunction()
{
echo 'code here';

echo 'code here';
}
]]>
</code>
<code title="Invalid: Functions contain multiple empty lines in a row.">
<![CDATA[
function myFunction()
{
echo 'code here';
<em>

</em>echo 'code here';
}
]]>
</code>
</code_comparison>
<standard>
<![CDATA[
There should be no superfluous whitespace at the end of a file.
A single final newline is allowed. A closing PHP tag is optional and ignored.
]]>
</standard>
<code_comparison>
<code title="Valid: A single newline appears after the last content in the file.">
<![CDATA[
function myFunction()
{
echo 'closing curly brace, 1 newline';
echo 'optional closing PHP tag';
echo 'then EOF';
}<em>
</em>
?>
]]>
</code>
<code title="Invalid: Multiple newlines appear after the last content in the file.">
<![CDATA[
function myFunction()
{
echo 'closing curly brace, 2 newlines';
echo 'optional closing PHP tag';
echo 'then EOF';
}<em>

</em>
?>
]]>
</code>
</code_comparison>
</documentation>