rspec/rules/S1997/php/rule.adoc
Fred Tingaud 16f6c0aecf
Inline adoc when include has no additional value (#1940)
Inline adoc files when they are included exactly once.

Also fix language tags because this inlining gives us better information
on what language the code is written in.
2023-05-25 14:18:12 +02:00

33 lines
662 B
Plaintext

== Why is this an issue?
Shared coding conventions allow teams to collaborate efficiently. To avoid the confusion that can be caused by tangling two coding languages in the same file, inline HTML should be avoided.
=== Noncompliant code example
[source,php]
----
<?php
$name = "George";
?>
<p> Hello <?php echo $name ?>!</p>
----
=== Exceptions
File having the extension ``++.phtml++`` are ignored by this rule because they are expected to have mixed PHP and HTML.
ifdef::env-github,rspecator-view[]
'''
== Implementation Specification
(visible only on this page)
=== Message
Remove the inline HTML in this file.
endif::env-github,rspecator-view[]