Add sniffs for @see, @throw and styling

Created on 27 April 2024, 4 months ago
Updated 3 May 2024, 4 months ago

Problem/Motivation

Tested these sniffs and there are no errors in core so let's add them and prevent future errors.

Steps to reproduce

Proposed resolution

Add the sniffs

Remaining tasks

User interface changes

API changes

Data model changes

Release notes snippet

πŸ“Œ Task
Status

Closed: works as designed

Version

11.0 πŸ”₯

Component
OtherΒ  β†’

Last updated about 7 hours ago

Created by

πŸ‡³πŸ‡ΏNew Zealand quietone New Zealand

Live updates comments and jobs are added and updated live.
  • Coding standards

    It involves compliance with, or the content of coding standards. Requires broad community agreement.

Sign in to follow issues

Merge Requests

Comments & Activities

  • Issue created by @quietone
  • Merge request !7784Add sniffs and example failures β†’ (Open) created by quietone
  • Status changed to Needs review 4 months ago
  • πŸ‡³πŸ‡ΏNew Zealand quietone New Zealand

    The first commit added the sniffs and forced errors to provide evidence of the errors the sniffs will find. The results are at https://git.drupalcode.org/project/drupal/-/jobs/1446421

  • πŸ‡³πŸ‡ΏNew Zealand quietone New Zealand
  • Status changed to RTBC 4 months ago
  • πŸ‡ΊπŸ‡ΈUnited States smustgrave

    Seems pretty straight forward.

  • First commit to issue fork.
  • πŸ‡ΊπŸ‡ΈUnited States rfay Palisade, CO, USA

    rfay β†’ changed the visibility of the branch 3443863-test-ignore-this-rfay to hidden.

  • πŸ‡ΊπŸ‡ΈUnited States rfay Palisade, CO, USA

    rfay β†’ changed the visibility of the branch 3443863-test-ignore-this-rfay to active.

  • πŸ‡ΊπŸ‡ΈUnited States rfay Palisade, CO, USA

    rfay β†’ changed the visibility of the branch 3443863-test-ignore-this-rfay to hidden.

  • πŸ‡¬πŸ‡§United Kingdom longwave UK

    Aren't these already included by <rule ref="Drupal.Commenting.FunctionComment">?

  • Status changed to Postponed: needs info 4 months ago
  • πŸ‡¦πŸ‡ΊAustralia mstrelan

    Agree with #10. Maybe we can test this with a PR that we would expect to fail and see if it's detected. In other words, needs steps to reproduce, marking PMNMI.

  • Status changed to Needs review 4 months ago
  • πŸ‡³πŸ‡ΏNew Zealand quietone New Zealand

    #10 and #11. I think this is answered in comment #3. Or are you asking for something else as proof?

  • πŸ‡¦πŸ‡ΊAustralia mstrelan

    @quietone we're saying that the first commit should already fail without any changes to phpcs.xml.dist, or at least we believe it should. My understanding is that <rule ref="Drupal.Commenting.FunctionComment"> on line 68 should already include all the ones you've added, minus the ones that are excluded on line 69-74.

  • Status changed to Closed: works as designed 4 months ago
  • πŸ‡³πŸ‡ΏNew Zealand quietone New Zealand

    @mstrelan, thanks.

    Well, the thing is I would swear that I made such a test as the first thing I did and the errors were not picked up. I thought it was off but continued on. I just retested with the files here and without the changes to phpcs.xml and, of course, the errors are found. Clearly, what I did and what I thought I did were two different things.

    Sorry for the noise.

Production build 0.71.5 2024