Skip to content

Commit 90ef8fb

Browse files
committed
Update docs
1 parent 3341c88 commit 90ef8fb

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# Changelog
22

33
## Not released
4+
- Renamed sniffs namespace (**breaking change**). Sniff are now referenced via `Inpsyde.CodeQuality...`
5+
instead of `InpsydeCodingStandard.CodeQuality...`
46
- Add `Psr4Sniff` to check PSR-4 compliance of files that contain classes auto-loadable entities.
57

68
## 0.9.0

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ The tree of used rules are listed in the `/docs/rules-list/custom.md` file in th
149149

150150
### Notes & Configuration
151151

152-
#### Skip `InpsydeCodeQuality.ReturnTypeDeclaration.NoReturnType` via doc bloc
152+
#### Skip `Inpsyde.CodeQuality.ReturnTypeDeclaration.NoReturnType` via doc bloc
153153

154154
As of v0.9, when there's no return type declared for a function, but it has a docbloc like:
155155
`@return {$type}|null` and the function _actually_ contains both `null` and not-null return
@@ -162,7 +162,7 @@ Also note that the warning **is** shown in case:
162162

163163

164164
#### PSR-4 Configuration
165-
`InpsydeCodeQuality.Psr4` rule needs some configuration to check namespace and
165+
`Inpsyde.CodeQuality.Psr4` rule needs some configuration to check namespace and
166166
class file paths.
167167
Without configuration the only thing the sniff does is to check that class name and file name match.
168168
The needed configuration mimics the PSR-4 configuration in `composer.json`.
@@ -179,7 +179,7 @@ Assuming a `composer.json` like:
179179
```
180180
the rule configuration should be:
181181
```xml
182-
<rule ref="InpsydeCodeQuality.Psr4">
182+
<rule ref="Inpsyde.CodeQuality.Psr4">
183183
<properties>
184184
<property name="psr4" type="array" value="Inpsyde\Foo=>src,Inpsyde\Foo\Bar\Baz=>baz" />
185185
</properties>
@@ -190,7 +190,7 @@ are checked to be compliant.
190190
If there are entities in the sniffer target paths that are not PSR-4 compliant (e.g. loaded via classmap
191191
or not autoloaded at all) those should be excluded via `exclude` property, e.g.
192192
```xml
193-
<rule ref="InpsydeCodeQuality.Psr4">
193+
<rule ref="Inpsyde.CodeQuality.Psr4">
194194
<properties>
195195
<property name="psr4" type="array" value="Inpsyde\SomePlugin=>src" />
196196
<property name="exclude" type="array" value="Inpsyde\ExcludeThis,Inpsyde\AndThis" />

0 commit comments

Comments
 (0)