Drupal.Commenting.FunctionComment.MissingReturnComment is not enable for all of core yet.
We are testing coding standards with PHP CodeSniffer, using the Drupal coding standards from the Coder module. We need to do a couple of steps in order to download and configure them so we can run a coding standards check.
Every coding standard is identified by a "sniff". For example, an imaginary coding standard that would require all llamas to be placed inside a square bracket fence would be called the "Drupal.AnimalControlStructure.BracketedFence sniff".
Open the file core/phpcs.xml.dist and add a line for the sniff of this ticket. The sniff name is in the issue title. Make sure your patch will include the addition of this line.
$ composer install
Once you have installed the phpcs package, you can list all the sniffs available to you like this:
$ ./vendor/bin/phpcs --standard=Drupal -e
This will give you a list of sniffs, and the Drupal-based ones should be present.
Add <include-pattern>core/tests/*</include-pattern> to the Drupal.Commenting.FunctionComment.MissingReturnComment rule.
Now you are ready to run the test! From within the core/ folder, run the following command to launch the test:
$ composer phpcs
When the test is complete it will present you a list of all the files that contain violations of your sniff, and the line numbers where the violations occur.
Enable sniff for the directory core/tests,
Follow the 'Approach' above to fix the failures
Review
Commit
Active
11.0 🔥
other
Looks great, the phpcs.xml change ensure we don't regress here.