2 <ruleset name="DokuWiki Coding Standard Standard" namespace="DokuWiki\CS\Standard">
3 <description>Coding Standard used for DokuWiki</description>
5 <!-- default config -->
8 <arg name="extensions" value="php"/>
10 <ini name="memory_limit" value="-1"/>
12 <!-- where to look -->
16 <file>../doku.php</file>
17 <file>../index.php</file>
18 <file>../feed.php</file>
19 <file>../install.php</file>
21 <!-- skip these completely -->
22 <exclude-pattern>*/lang/*/lang.php</exclude-pattern>
23 <exclude-pattern>*/lang/*/settings.php</exclude-pattern>
24 <exclude-pattern>*/_test/*</exclude-pattern>
25 <exclude-pattern>*/vendor/*</exclude-pattern>
27 <!-- 3rd party libs, these should be moved to composer some day -->
28 <exclude-pattern>*/inc/DifferenceEngine.php</exclude-pattern>
29 <exclude-pattern>*/inc/JpegMeta.php</exclude-pattern>
30 <exclude-pattern>*/lib/plugins/authad/adLDAP</exclude-pattern>
32 <!-- deprecated files to be removed soon -->
33 <exclude-pattern>*/inc/parser/parser.php</exclude-pattern>
35 <!-- rules on top of PSR-12 -->
37 <!-- This rule breaks the single line guard pattern that we prefer to keep using -->
38 <exclude name="Generic.ControlStructures.InlineControlStructure.NotAllowed"/>
40 <!-- we have lots of legacy classes without name spaces -->
41 <exclude name="PSR1.Classes.ClassDeclaration.MissingNamespace"/>
44 <!-- disable some rules for certain paths, for legacy support -->
45 <rule ref="Squiz.Classes.ValidClassName.NotCamelCaps">
46 <exclude-pattern>*/inc/Plugin.php</exclude-pattern>
47 <exclude-pattern>*/inc/PluginInterface.php</exclude-pattern>
48 <exclude-pattern>*/inc/PluginTrait.php</exclude-pattern>
50 <exclude-pattern>*/lib/plugins/*.php</exclude-pattern>
51 <exclude-pattern>*/lib/plugins/*/action.php</exclude-pattern>
52 <exclude-pattern>*/lib/plugins/*/action/*.php</exclude-pattern>
53 <exclude-pattern>*/lib/plugins/*/admin.php</exclude-pattern>
54 <exclude-pattern>*/lib/plugins/*/admin/*.php</exclude-pattern>
55 <exclude-pattern>*/lib/plugins/*/auth.php</exclude-pattern>
56 <exclude-pattern>*/lib/plugins/*/auth/*.php</exclude-pattern>
57 <exclude-pattern>*/lib/plugins/*/cli.php</exclude-pattern>
58 <exclude-pattern>*/lib/plugins/*/cli/*.php</exclude-pattern>
59 <exclude-pattern>*/lib/plugins/*/helper.php</exclude-pattern>
60 <exclude-pattern>*/lib/plugins/*/helper/*.php</exclude-pattern>
61 <exclude-pattern>*/lib/plugins/*/remote.php</exclude-pattern>
62 <exclude-pattern>*/lib/plugins/*/remote/*.php</exclude-pattern>
63 <exclude-pattern>*/lib/plugins/*/syntax.php</exclude-pattern>
64 <exclude-pattern>*/lib/plugins/*/syntax/*.php</exclude-pattern>
66 <exclude-pattern>*/inc/parser/*</exclude-pattern>
69 <!-- underscore skips exposing public methods to remote api -->
70 <rule ref="PSR2.Methods.MethodDeclaration.Underscore">
71 <exclude-pattern>*/inc/Extension/RemotePlugin.php</exclude-pattern>
72 <exclude-pattern>*/lib/plugins/*/remote.php</exclude-pattern>
73 <exclude-pattern>*/lib/plugins/*/remote/*.php</exclude-pattern>
75 <exclude-pattern>*/inc/parser/*</exclude-pattern>
78 <rule ref="PSR2.Classes.PropertyDeclaration.Underscore">
79 <exclude-pattern>*/inc/parser/*</exclude-pattern>
82 <rule ref="PSR1.Methods.CamelCapsMethodName.NotCamelCaps">
83 <exclude-pattern>*/inc/Extension/PluginInterface.php</exclude-pattern>
84 <exclude-pattern>*/inc/Extension/PluginTrait.php</exclude-pattern>
86 <exclude-pattern>*/inc/parser/*</exclude-pattern>