Skip to content

Commit 26c9ac5

Browse files
committed
feat: InpsydeTemplates inherits Inpsyde ruleset
1 parent 847824a commit 26c9ac5

File tree

2 files changed

+26
-6
lines changed

2 files changed

+26
-6
lines changed

InpsydeTemplates/ruleset.xml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,8 @@
33

44
<description>Coding standards for PHP templates.</description>
55

6+
<rule ref="Inpsyde">
7+
<exclude name="Inpsyde.CodeQuality.NoElse" />
8+
</rule>
9+
610
</ruleset>

README.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -184,15 +184,31 @@ For **notes and configuration** see [`/inpsyde-custom-sniffs.md`](/inpsyde-custo
184184

185185
## Templates Rules
186186

187-
InpsydeTemplates ruleset contains custom rules targeted to the PHP templates and views.
188-
To enable the ruleset only for templates the following configuration could be used:
187+
InpsydeTemplates ruleset extends Inpsyde ruleset apart from several rules that doesn't make sense in
188+
the templating context. Several template-specific sniffs are added.
189+
190+
The recommended way of using InpsydeTemplates ruleset:
189191

190192
```xml
191-
<rule ref="InpsydeTemplates">
192-
<include-pattern>*/templates/*</include-pattern>
193-
<include-pattern>*/views/*</include-pattern>
194-
</rule>
193+
<ruleset>
194+
<file>./src/</file>
195+
<file>./tests</file>
196+
<file>./templates</file>
197+
<file>./block-views</file>
198+
199+
<rule ref="Inpsyde">
200+
<exclude-pattern>*/templates/*</exclude-pattern>
201+
<exclude-pattern>*/views/*</exclude-pattern>
202+
</rule>
203+
204+
<rule ref="InpsydeTemplates">
205+
<include-pattern>*/templates/*</include-pattern>
206+
<include-pattern>*/views/*</include-pattern>
207+
</rule>
208+
</ruleset>
195209
```
210+
The following Inpsyde rules are disabled:
211+
* NoElse
196212

197213
The following templates-specific rules are available:
198214

0 commit comments

Comments
 (0)