Merge pull request #145 from stronk7/main

Disable some phpcs (phpdoc) sniffs
moodlehq · Apr 22, 2024 · ab6a27d · ab6a27d
2 parents 4a037a7 + 1421fe5
commit ab6a27d
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 15 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -149,11 +149,6 @@ jobs:
         if: ${{ !cancelled() }}
         run: moodle-plugin-ci phplint
 
-      - name: PHP Copy/Paste Detector
-        continue-on-error: true # This step will show errors but will not fail
-        if: ${{ !cancelled() }}
-        run: moodle-plugin-ci phpcpd
-
       - name: PHP Mess Detector
         continue-on-error: true # This step will show errors but will not fail
         if: ${{ !cancelled() }}
@@ -163,15 +158,6 @@ jobs:
         if: ${{ !cancelled() }}
         run: moodle-plugin-ci codechecker --max-warnings 0
 
-      - name: Moodle PHPDoc Checker
-        if: ${{ false }}
-        run: |
-          if [ ${{ matrix.plugin-ci }} == "^3" ]; then
-              moodle-plugin-ci phpdoc
-          else
-              moodle-plugin-ci phpdoc --max-warnings 0
-          fi
-
       - name: Validating
         if: ${{ !cancelled() }}
         run: moodle-plugin-ci validate

diff --git a/file.php b/file.php
@@ -22,6 +22,10 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+// phpcs:disable moodle.Commenting.VariableComment.Missing
+// phpcs:disable moodle.Commenting.MissingDocblock.Missing
+// phpcs:disable moodle.Commenting.VariableComment.TagNotAllowed
+
 defined('MOODLE_INTERNAL') || die;
 
 /**

diff --git a/lang/en/local_moodlecheck.php b/lang/en/local_moodlecheck.php
@@ -22,6 +22,8 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+// phpcs:disable moodle.Files.LangFilesOrdering
+
 $string['pluginname'] = 'Moodle PHPdoc check';
 $string['path'] = 'Path(s)';
 $string['ignorepath'] = 'Subpaths to ignore';

diff --git a/locallib.php b/locallib.php
@@ -22,9 +22,12 @@
  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  */
 
+// phpcs:disable moodle.Commenting.VariableComment.Missing
+// phpcs:disable moodle.Commenting.MissingDocblock.Missing
+
 defined('MOODLE_INTERNAL') || die;
 require_once($CFG->libdir . '/formslib.php');
-require_once($CFG->dirroot. '/local/moodlecheck/file.php');
+require_once($CFG->dirroot . '/local/moodlecheck/file.php');
 
 /**
  * Handles one rule

diff --git a/tests/phpdocs_basic_test.php b/tests/phpdocs_basic_test.php
@@ -46,6 +46,11 @@ public function test_local_moodlecheck_normalise_function_type(string $inputtype
         );
     }
 
+    /**
+     * Data provider for test_local_moodlecheck_normalise_function_type.
+     *
+     * @return array
+     */
     public static function local_moodlecheck_normalise_function_type_provider(): array {
         return [
             'Simple case' => [