Migrate moodle-local_moodlecheck phpdoc checks to this standard

[andrewnicols]

I think we can probably migrate most of our custom-written phpdoc checks into this standard.

There are several, but (un)helpfully phpcs sucks at documenting the rules available. Here's a summary of some of them:
https://stackoverflow.com/questions/13767550/is-there-a-phpcs-standard-targeting-php-docblocks

We will need to tailor this a little, but it should be able to capture most of the phpdoc sniffs for methods at the very least.

• packagespecified - Check package tags #110 / Remove package checks. moodle-local_moodlecheck#131
• packagevalid - Check package tags #110 / Remove package checks. moodle-local_moodlecheck#131
• categoryvalid - Check category tag #112 / Remove category checks moodle-local_moodlecheck#132
• noemptysecondline - (already checked by PSR and Boilerplate) / Remove noemptysecondlines check moodle-local_moodlecheck#133
• filephpdocpresent - Add sniff to detect missing docblocks #119 / Remove filephpdocpresent and classesdocumented moodle-local_moodlecheck#134
• classesdocumented - Add sniff to detect missing docblocks #119 / Remove filephpdocpresent and classesdocumented moodle-local_moodlecheck#134
• functionsdocumented - Add sniff to detect missing docblocks #119 / Docblock removals moodle-local_moodlecheck#137
• variablesdocumented - Add sniff to cover correct use of @var #121 / Variablesdocumented removal moodle-local_moodlecheck#135
• constsdocumented - Add sniff to detect missing docs for constants #129 / Remove constsdocumented moodle-local_moodlecheck#140
• definesdocumented - N/A / Remove all checks for define() moodle-local_moodlecheck#141
• noinlinephpdocs - Add sniff to detect use of /// comments. #137 / Remove noinlinephpdocs check moodle-local_moodlecheck#144
• phpdocsfistline - Add sniff to check for first line descriptions #134 / Remove phpdocsfistline and functiondescription (#142) moodle-local_moodlecheck#142
• functiondescription - Add sniff to check for first line descriptions #134 / Remove phpdocsfistline and functiondescription (#142) moodle-local_moodlecheck#142
• functionarguments
• variableshasvar - Add sniff to cover correct use of @var #121 / Variablesdocumented removal moodle-local_moodlecheck#135
• definedoccorrect - N/A / Remove all checks for define() moodle-local_moodlecheck#141
• filehascopyright - Add sniffs for file docblock @copyright and @license #125 / Remove filehascopyright, filehaslicense moodle-local_moodlecheck#139
• filehaslicense - Add sniffs for file docblock @copyright and @license #125 / Remove filehascopyright, filehaslicense moodle-local_moodlecheck#139
• phpdocsinvalidtag - Introduce various doc tag sniffs #124 / Remove phpdocsinvalidtag, phpdocsnotrecommendedtag, phpdocsinvalidpathtag moodle-local_moodlecheck#136
• phpdocsnotrecommendedtag - Introduce various doc tag sniffs #124 / Remove phpdocsinvalidtag, phpdocsnotrecommendedtag, phpdocsinvalidpathtag moodle-local_moodlecheck#136
• phpdocsinvalidpathtag - Introduce various doc tag sniffs #124 / Remove phpdocsinvalidtag, phpdocsnotrecommendedtag, phpdocsinvalidpathtag moodle-local_moodlecheck#136
• phpdocsinvalidinlinetag
• phpdocsuncurlyinlinetag
• phpdoccontentsinlinetag

Forum discussion: https://moodle.org/mod/forum/discuss.php?d=455786

[stronk7]

Just thinking... maybe we should comment about this plan also @:

• https://github.com/moodlehq/moodle-local_moodlecheck/issues
• dev chat / forum

Stating that, progressively, we are proceeding to migrate the current checks to moodle-cs and removing them from local_moodlecheck as we go?

So, some overlapping / dupe reports can be expected here and there (when releases adding and removing don't match) but, ultimately, removing local_moodlecheck from everywhere (CiBoT, moodle-plugin-ci, ...) once the transition is complete.

Ciao :-)