Documented new props for Generic.Formatting.SpaceAfterNot

Author: gsherwood

wiki/Customisable-Sniff-Properties.md

@@ -11,6 +11,7 @@ For more information about changing sniff behaviour by customising your ruleset,
     * [Generic.Files.LineEndings](#genericfileslineendings)
     * [Generic.Files.LineLength](#genericfileslinelength)
     * [Generic.Formatting.MultipleStatementAlignment](#genericformattingmultiplestatementalignment)
+    * [Generic.Formatting.SpaceAfterNot](#genericformattingspaceafternot)
     * [Generic.Functions.OpeningFunctionBraceBsdAllman](#genericfunctionsopeningfunctionbracebsdallman)
     * [Generic.Functions.OpeningFunctionBraceKernighanRitchie](#genericfunctionsopeningfunctionbracekernighanritchie)
     * [Generic.Metrics.CyclomaticComplexity](#genericmetricscyclomaticcomplexity)
@@ -228,6 +229,55 @@ If the `error` property is set to `true`, an error will be thrown for violations
 </rule>
 ```
 
+### Generic.Formatting.SpaceAfterNot
+
+Property Name  | Type | Default | Available Since
+-------------- | ---- | ------- | ---------------
+spacing        | int  | 1       | 3.4.0
+ignoreNewlines | bool | false   | 3.4.0
+
+This sniff checks the spacing after a `!` operator. By default, the sniff ensures there is one space after the operator, as shown in the following code snippet:
+
+```php
+if (! $foo) {
+}
+```
+
+Another common way of using the `!` operator is to follow it with no space, as shown in the following code snippet:
+
+```php
+if (!$foo) {
+}
+```
+
+If you prefer to write your code like this, you can set the `spacing` property to `0`, or whatever padding you prefer.
+
+```xml
+<rule ref="Generic.Formatting.SpaceAfterNot">
+    <properties>
+        <property name="spacing" value="0" />
+    </properties>
+</rule>
+```
+
+Sometimes complex statements are broken over multiple lines for readability, as shown in the following code snippet:
+```php
+if (!
+    ($foo || $bar)
+) {
+}
+```
+
+By default, this sniff will generate an error if the `!` operator is followed by a newline. Setting the `ignoreNewlines` property to `true` will allow newline characters after a `!` operator.
+
+```xml
+<rule ref="Generic.Formatting.SpaceAfterNot">
+    <properties>
+        <property name="ignoreNewlines" value="true" />
+    </properties>
+</rule>
+```
+
 ### Generic.Functions.OpeningFunctionBraceBsdAllman
 
 Property Name  | Type | Default | Available Since