Merge pull request #9 from asispts/comment

Disallow one-line property doc comment

CHANGELOG.md

@@ -7,8 +7,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+  - Disallow one-line property doc comment rule (#7)
+
 ### Fixed
-  - Fix PSR12 FileHeader incorrect order
+  - Fix PSR12 FileHeader incorrect order (#6)
 
 ## [1.0] - 2023-04-21
 Initial release

RULES.md

@@ -228,3 +228,4 @@ $arr = array(); // not allowedgit a
 34. Detect unused variables
 35. Detect unused function parameters
 36. Detect unused inherited variables passed to a closure
+37. Disallow one-line property doc comment

ptscs/ruleset.xml

@@ -191,6 +191,7 @@
     <rule ref="SlevomatCodingStandard.Variables.UnusedVariable" />
     <rule ref="SlevomatCodingStandard.Functions.UnusedParameter" />
     <rule ref="SlevomatCodingStandard.Functions.UnusedInheritedVariablePassedToClosure" />
+    <rule ref="SlevomatCodingStandard.Commenting.DisallowOneLinePropertyDocComment" />
 
 
     <!--++++++++++++++++++++++++++++++++++++

tests/Sniffs/Slevomat/DisallowOneLinePropertyDocCommentTest.php

@@ -0,0 +1,26 @@
+<?php declare(strict_types=1);
+
+namespace Ptscs\Tests\Sniffs\Slevomat;
+
+use Iterator;
+use Ptscs\Tests\SniffTestCase;
+use Ptscs\Tests\Utils\ErrorData;
+
+final class DisallowOneLinePropertyDocCommentTest extends SniffTestCase
+{
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->appendExclude('Squiz.Classes.ClassFileName.NoMatch');
+    }
+
+    public static function provideTestData(): Iterator
+    {
+        yield[
+          [
+            // phpcs:ignore Generic.Files.LineLength.TooLong
+            new ErrorData(7, 'SlevomatCodingStandard.Commenting.DisallowOneLinePropertyDocComment.OneLinePropertyComment'),
+          ],
+        ];
+    }
+}

tests/Sniffs/Slevomat/_data/DisallowOneLinePropertyDocComment.php.fixed

@@ -0,0 +1,17 @@
+<?php declare(strict_types=1);
+
+namespace App;
+
+final class Foobar
+{
+    /**
+     * @var string
+     */
+    public $name;
+
+    public function __invoke()
+    {
+        /** @var string */
+        $foobar = 'Should not format this doc comment';
+    }
+}

tests/Sniffs/Slevomat/_data/DisallowOneLinePropertyDocComment.php.inc

@@ -0,0 +1,15 @@
+<?php declare(strict_types=1);
+
+namespace App;
+
+final class Foobar
+{
+    /** @var string */
+    public $name;
+
+    public function __invoke()
+    {
+        /** @var string */
+        $foobar = 'Should not format this doc comment';
+    }
+}

tests/Sniffs/Squiz/_data/ClassProperty.php.fixed

@@ -6,7 +6,9 @@ class Class1
 }
 class Class2
 {
-    /** @doc */
+    /**
+     * doc comment
+     */
     private $var1;
 }
 class Class3
@@ -18,14 +20,18 @@ class Class3
 }
 class Class4
 {
-    /** docs */
+    /**
+     * doc comment
+     */
     #[attribute]
     private $var1;
 }
 class Class5
 {
     #[attribute]
 
-    /** docs */
+    /**
+     * doc comment
+     */
     private $var1;
 }

tests/Sniffs/Squiz/_data/ClassProperty.php.inc

@@ -10,7 +10,7 @@ class Class1
 }
 class Class2
 {
-    /** @doc */
+    /** doc comment */
 
 
     private $var1;
@@ -24,7 +24,7 @@ class Class3
 }
 class Class4
 {
-    /** docs */
+    /** doc comment */
 
 
     #[attribute]
@@ -37,7 +37,7 @@ class Class5
     #[attribute]
 
 
-    /** docs */
+    /** doc comment */
 
 
     private $var1;