allow marking enum cases as deprecated

[pilif]

This PR will allow an @deprecated annotation to be placed on enum cases which will then cause a DeprecatedConstant issue to be raised when the case is being referenced.

I'm unsure as to whether this is the correct way to do things as I'm not too familiar with the psalm internals, so I'm very happy about pointers in how to do this correctly.

Also, ideally, I would like to have supported the #[Psalm\Deprecated] attribute too, but I don't think the php parser is exposing attributes on enum cases - at least I could not get to them, but maybe I looked in the wrong spot.

[weirdan]

Attributes are available on enum cases:

    public $stmts =>
    array(1) {
      [0] =>
      class PhpParser\Node\Stmt\EnumCase#1183 (4) {
        public $name =>
        class PhpParser\Node\Identifier#1182 (2) {
          public $name =>
          string(1) "A"
          protected $attributes =>
          array(4) {
            'startLine' =>
            int(5)
            'startFilePos' =>
            int(50)
            'endLine' =>
            int(5)
            'endFilePos' =>
            int(50)
          }
        }
        public $expr =>
        NULL
        public $attrGroups =>
        array(1) {
          [0] =>
          class PhpParser\Node\AttributeGroup#1181 (2) {
            public $attrs =>
            array(1) {
              [0] =>
              class PhpParser\Node\Attribute#1180 (3) {
                public $name =>
                class PhpParser\Node\Name\FullyQualified#1179 (2) {
                  public $parts =>
                  array(2) {
                    [0] =>
                    string(5) "Psalm"
                    [1] =>
                    string(10) "Deprecated"
                  }

[pilif]

thanks. I must have been looking at the wrong spot then (the attrGroups I checked was empty).

I'll check later (tomorrow Europe time - I'm on family duty now) and update the PR

[pilif]

yes. you were totally right. the attributes are available.

I have pushed a second commit that adds support for the Psalm\Deprecated and JetBrains\PhpStorm\Deprecated attributes for enum cases.

The patch as shown on GitHub looks a bit crazy because I have extracted the attribute resolution into a new method as it was exactly identical for the property storage too

[pilif]

I pushed another commit that updates the docs. However, that fails a test because the documentation samples are checked (very cool) with php 8.0 (not so good).

How should I proceed?

• update the GitHub Action to parse the tests with php-8.1?
• remove the updated code sample?
• add support for version dependent sample codes in the docs? (feels like overkill)

[orklah]

Let's upgrade that to 8.1, it should not be an issue

[weirdan]

Wouldn't adding the issue to the list below suffice?

psalm/tests/DocumentationTest.php

Lines 312 to 318 in 646ba98

	case 'InvalidEnumBackingType':
	case 'InvalidEnumCaseValue':
	case 'DuplicateEnumCase':
	case 'DuplicateEnumCaseValue':
	case 'NoEnumProperties':
	$php_version = '8.1';
	break;

[pilif]

Wouldn't adding the issue to the list below suffice?

yes. you're right. I noticed only after asking about the general PHP update, so that what I've done. In my rebased commits, I have removed the PHP version change and followed your suggestion.

[weirdan]

Thanks!