codestyle/library.xml at 2.x · stefna/codestyle · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
<?xml version="1.0"?>
<ruleset name="codestyle">
	<description>Stefna coding standard.</description>
	<arg name="tab-width" value="4"/>
	<arg name="parallel" value="100"/>

	<!-- 2. General -->

	<!-- 2.1 Basic Coding Standard -->
	<rule ref="./src/Stefna"/>

	<!-- Include the whole PER-12 standard -->
	<rule ref="PSR12">
		<exclude name="Generic.WhiteSpace.DisallowTabIndent"/>
		<exclude name="Squiz.ControlStructures.ControlSignature.SpaceAfterCloseBrace"/>
		<exclude name="Squiz.ControlStructures.ControlSignature.NewlineAfterOpenBrace"/>
		<exclude name="Squiz.Functions.MultiLineFunctionDeclaration.BraceOnSameLine"/>
		<exclude name="PSR1.Methods.CamelCapsMethodName"/>
		<exclude name="PSR12.Files.FileHeader"/>
		<exclude name="PSR12.Files.OpenTag.NotAlone"/>
		<exclude name="PSR12.ControlStructures.ControlStructureSpacing"/>
	</rule>

	<!-- 2.3 Lines -->
	<!-- 2.4 Indenting -->

	<!-- Code MUST use an indent of 4 spaces, and MUST NOT use tabs for indenting. -->
	<rule ref="Generic.WhiteSpace.ScopeIndent">
		<properties>
			<property name="ignoreIndentationTokens" type="array">
				<element value="T_COMMENT"/>
				<element value="T_DOC_COMMENT_OPEN_TAG"/>
			</property>
			<property name="tabIndent" value="true"/>
		</properties>
	</rule>
	<rule ref="Generic.WhiteSpace.DisallowSpaceIndent"/>

	<!-- Doc block rules -->
	<rule ref="Stefna.Commenting.DocComment">
		<exclude name="Stefna.Commenting.DocComment.TagValueIndent"/>
		<exclude name="Stefna.Commenting.DocComment.NonParamGroup"/>
		<exclude name="Stefna.Commenting.DocComment.MissingShort"/>
	</rule>

	<!-- Array code styles-->
	<rule ref="Generic.Arrays.DisallowLongArraySyntax.Found"/>
	<rule ref="Generic.Arrays.ArrayIndent"/>

	<rule ref="Squiz.WhiteSpace.ScopeClosingBrace">
		<exclude name="Squiz.WhiteSpace.ScopeClosingBrace.ContentBefore"/>
	</rule>

	<!-- Enforce trailing comma in arrays -->
	<rule ref="Squiz.Arrays.ArrayDeclaration">
		<exclude name="Squiz.Arrays.ArrayDeclaration.ValueNotAligned"/>
		<exclude name="Squiz.Arrays.ArrayDeclaration.CloseBraceNotAligned"/>
		<exclude name="Squiz.Arrays.ArrayDeclaration.DoubleArrowNotAligned"/>
		<exclude name="Squiz.Arrays.ArrayDeclaration.KeyNotAligned"/>
		<exclude name="Squiz.Arrays.ArrayDeclaration.MultiLineNotAllowed"/>
		<exclude name="Squiz.Arrays.ArrayDeclaration.SingleLineNotAllowed"/>
		<exclude name="Squiz.Arrays.ArrayDeclaration.NoKeySpecified"/>
		<exclude name="Squiz.Arrays.ArrayDeclaration.ValueNoNewline"/>
	</rule>

	<!-- special rules for else, elseif, catch, finally -->
	<rule ref="Stefna.ControlStructures.BracketPlacement"/>
	<rule ref="Stefna.ControlStructures.TryCatchDeclaration"/>
	<rule ref="Stefna.ControlStructures.ControlStructureSpacing"/>
	<!-- needed special control structure check to not collide with ElseCatch -->
	<!-- <rule ref="Stefna.ControlStructures.ControlSignature"/> -->
	<!-- <rule ref="Stefna.ControlStructures.ScopeClosingBrace"/> -->
	<rule ref="Stefna.Naming.CamelCapsMethodName">
		<properties>
			<property name="strict" value="false"/>
		</properties>
	</rule>
	<!---->
	<!-- <rule ref="Stefna.Functions.ArgumentTrailingComma"/> -->
	<!-- <rule ref="Stefna.Functions.MultiLineFunctionDeclaration"/> -->
	<rule ref="Stefna.Functions.MultiLineFunctionDeclaration">
		<exclude name="Stefna.Functions.MultiLineFunctionDeclaration.BraceOnSameLine"/>
	</rule>
	<rule ref="Stefna.Functions.BlankLines"/>
	<rule ref="Stefna.Files.DeclareStrict"/>
	<rule ref="Stefna.Closures.Static"/>
	<rule ref="Stefna.Functions.EmptyFunctionBody"/>

	<rule ref="Squiz.Strings.DoubleQuoteUsage">
		<exclude name="Squiz.Strings.DoubleQuoteUsage.ContainsVar"/>
	</rule>

	<config name="installed_paths" value="vendor/slevomat/coding-standard"/>
	<rule ref="SlevomatCodingStandard.Namespaces.UnusedUses">
		<properties>
			<property name="searchAnnotations" value="true" />
		</properties>
	</rule>
	<rule ref="SlevomatCodingStandard.Namespaces.NamespaceSpacing">
		<properties>
			<property name="linesCountBeforeNamespace" value="1" />
			<property name="linesCountAfterNamespace" value="1" />
		</properties>
	</rule>
	<rule ref="SlevomatCodingStandard.Classes.ClassMemberSpacing"/>
	<rule ref="SlevomatCodingStandard.Classes.MethodSpacing"/>
	<rule ref="SlevomatCodingStandard.Namespaces.AlphabeticallySortedUses"/>
	<rule ref="SlevomatCodingStandard.Namespaces.DisallowGroupUse"/>
	<rule ref="SlevomatCodingStandard.Namespaces.MultipleUsesPerLine"/>
	<rule ref="SlevomatCodingStandard.Namespaces.UseDoesNotStartWithBackslash"/>
	<rule ref="SlevomatCodingStandard.Attributes.DisallowAttributesJoining"/>
	<rule ref="SlevomatCodingStandard.Attributes.DisallowMultipleAttributesPerLine"/>
	<rule ref="SlevomatCodingStandard.ControlStructures.DisallowYodaComparison"/>
	<rule ref="SlevomatCodingStandard.Exceptions.DeadCatch"/>
	<rule ref="SlevomatCodingStandard.Functions.RequireTrailingCommaInDeclaration"/>
	<rule ref="SlevomatCodingStandard.Functions.RequireTrailingCommaInCall"/>
	<rule ref="SlevomatCodingStandard.Arrays.DisallowImplicitArrayCreation"/>
	<rule ref="SlevomatCodingStandard.Attributes.AttributeAndTargetSpacing"/>
</ruleset>