Skip to content

Commit c4dcd1a

Browse files
committed
Cleanup docs
1 parent 9e8227b commit c4dcd1a

File tree

6 files changed

+15
-228
lines changed

6 files changed

+15
-228
lines changed

docs/rules-list/custom.md renamed to docs/custom-rules-list.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44
- Inpsyde.CodeQuality
55
- Inpsyde.CodeQuality.ArgumentTypeDeclaration
66
- Inpsyde.CodeQuality.ArgumentTypeDeclaration.NoArgumentType
7+
- Inpsyde.CodeQuality.ConstantVisibility
8+
- Inpsyde.CodeQuality.ConstantVisibility.NotFound
79
- Inpsyde.CodeQuality.ElementNameMinimalLength
810
- Inpsyde.CodeQuality.ElementNameMinimalLength.TooShort
911
- Inpsyde.CodeQuality.ForbiddenPublicProperty

docs/inpsyde-rules-configuration.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,22 @@ By default the whitelisted names are:
2828
- `'it'`
2929
- `'db'`
3030

31-
but they can be configured via `allowedShortNames` config, e.g.:
31+
but they can be overridden via `allowedShortNames` config, e.g.:
3232

3333
```xml
3434
<rule ref="Inpsyde.CodeQuality.ElementNameMinimalLengthSniff">
3535
<properties>
36-
<property name="allowedShortNames" type="array" value="id,db,x,y" />
36+
<property name="allowedShortNames" type="array" value="id,db,ok,x,y" />
37+
</properties>
38+
</rule>
39+
```
40+
41+
or they can be extended (keeping the default allowed) via `additionalAllowedNames` config, e.g.:
42+
43+
```xml
44+
<rule ref="Inpsyde.CodeQuality.ElementNameMinimalLengthSniff">
45+
<properties>
46+
<property name="additionalAllowedNames" type="array" value="x,y" />
3747
</properties>
3848
</rule>
3949
```
@@ -292,4 +302,4 @@ It is possible to also ignore some other names via the `ignoredNames` property:
292302
<property name="ignoredNames" type="array" value="ALLOWED,allowed_snake" />
293303
</properties>
294304
</rule>
295-
```
305+
```

docs/rules-list/generic.md

Lines changed: 0 additions & 61 deletions
This file was deleted.

docs/rules-list/neutron-standard.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

docs/rules-list/psr.md

Lines changed: 0 additions & 79 deletions
This file was deleted.

docs/rules-list/wordpress.md

Lines changed: 0 additions & 65 deletions
This file was deleted.

0 commit comments

Comments
 (0)