Add sniff to detect use of /// comments.

moodle/Sniffs/Commenting/NoInlineSniff.php

@@ -0,0 +1,68 @@
+<?php
+
+// This file is part of Moodle - https://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <https://www.gnu.org/licenses/>.
+
+namespace MoodleHQ\MoodleCS\moodle\Sniffs\Commenting;
+
+use MoodleHQ\MoodleCS\moodle\Util\MoodleUtil;
+use MoodleHQ\MoodleCS\moodle\Util\Docblocks;
+use PHP_CodeSniffer\Sniffs\Sniff;
+use PHP_CodeSniffer\Files\File;
+
+/**
+ * Checks for the presence of inline docblocks.
+ *
+ * Inline docblocks are those which start with three ///.
+ *
+ * @copyright  2024 Andrew Lyons <[email protected]>
+ * @license    https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class NoInlineSniff implements Sniff
+{
+    /**
+     * Register for open tag (only process once per file).
+     */
+    public function register() {
+        return [
+            T_COMMENT,
+        ];
+    }
+
+    /**
+     * Processes php files and perform various checks with file.
+     *
+     * @param File $phpcsFile The file being scanned.
+     * @param int $stackPtr The position in the stack.
+     */
+    public function process(File $phpcsFile, $stackPtr) {
+        $tokens = $phpcsFile->getTokens();
+        $token = $tokens[$stackPtr];
+
+        if (strpos($token['content'], '///') === 0) {
+            $fix = $phpcsFile->addFixableError(
+                'Invalid inline comment found. Comments should not start with three slashes (///).',
+                $stackPtr,
+                'InvalidInlineComment'
+            );
+
+            if ($fix === true) {
+                $phpcsFile->fixer->beginChangeset();
+                $phpcsFile->fixer->replaceToken($stackPtr, preg_replace('@^/{2,}@', '//', $token['content']));
+                $phpcsFile->fixer->endChangeset();
+            }
+        }
+    }
+}

moodle/Tests/Sniffs/Commenting/NoInlineSniffTest.php

@@ -0,0 +1,66 @@
+<?php
+
+// This file is part of Moodle - https://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <https://www.gnu.org/licenses/>.
+
+namespace MoodleHQ\MoodleCS\moodle\Tests\Sniffs\Commenting;
+
+use MoodleHQ\MoodleCS\moodle\Tests\MoodleCSBaseTestCase;
+
+/**
+ * Test the NoInlineSniff sniff.
+ *
+ * @copyright  2024 onwards Andrew Lyons <[email protected]>
+ * @license    https://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ *
+ * @covers \MoodleHQ\MoodleCS\moodle\Sniffs\Commenting\NoInlineSniff
+ */
+class NoInlineSniffTest extends MoodleCSBaseTestCase
+{
+    /**
+     * @dataProvider fixtureProvider
+     */
+    public function testFixtures(
+        string $fixture,
+        array $errors,
+        array $warnings
+    ): void {
+        $this->setStandard('moodle');
+        $this->setSniff('moodle.Commenting.NoInline');
+        $this->setFixture(sprintf("%s/fixtures/NoInline/%s.php", __DIR__, $fixture));
+        $this->setWarnings($warnings);
+        $this->setErrors($errors);
+
+        $this->verifyCsResults();
+    }
+
+    public static function fixtureProvider(): array {
+        return [
+            'Standard fixes' => [
+                'fixture' => 'standard',
+                'errors' => [
+                    3 => 'Invalid inline comment found. Comments should not start with three slashes (///).',
+                    5 => 'Invalid inline comment found. Comments should not start with three slashes (///).',
+                    8 => 'Invalid inline comment found. Comments should not start with three slashes (///).',
+                    10 => 'Invalid inline comment found. Comments should not start with three slashes (///).',
+                    13 => 'Invalid inline comment found. Comments should not start with three slashes (///).',
+                    19 => 'Invalid inline comment found. Comments should not start with three slashes (///).',
+                    20 => 'Invalid inline comment found. Comments should not start with three slashes (///).',
+                ],
+                'warnings' => [],
+            ],
+        ];
+    }
+}

moodle/Tests/Sniffs/Commenting/fixtures/NoInline/standard.php

@@ -0,0 +1,20 @@
+<?php
+
+/// Inline comment in a file.
+
+/// Inline comment on a function.
+function inlineCommentExample() {}
+
+/// Inline comment on a class.
+class InlineCommentExample {
+    /// Inline comment on a property.
+    public $property;
+
+    /// Inline comment on a method.
+    public function method() {}
+}
+
+// A regular comment which contains three slashes in it ///.
+
+/// A three slash comment which has more than three slashes later in it ////.
+///////// All the slashes.

moodle/Tests/Sniffs/Commenting/fixtures/NoInline/standard.php.fixed

@@ -0,0 +1,20 @@
+<?php
+
+// Inline comment in a file.
+
+// Inline comment on a function.
+function inlineCommentExample() {}
+
+// Inline comment on a class.
+class InlineCommentExample {
+    // Inline comment on a property.
+    public $property;
+
+    // Inline comment on a method.
+    public function method() {}
+}
+
+// A regular comment which contains three slashes in it ///.
+
+// A three slash comment which has more than three slashes later in it ////.
+// All the slashes.