(PHP 8.1) Added support for class constants with FINAL keyword (#1110)

* Added support for class constants with FINAL keyword

* updated ts definition

* reformat types with prettier to fix but in CI

Author: cseufert

package.json

@@ -20,7 +20,7 @@
     "build": "webpack --config webpack.config.js",
     "-postbuild": "yarpm run build-docs",
     "build-docs": "jsdoc -c .jsdoc.json",
-    "build-types": "jsdoc -t node_modules/tsd-jsdoc/dist -r src -d .",
+    "build-types": "jsdoc -t node_modules/tsd-jsdoc/dist -r src -d . && prettier -w types.d.ts",
     "publish-docs": "git subtree push --prefix docs origin gh-pages",
     "benchmark": "node test/benchmark.js"
   },
@@ -81,5 +81,6 @@
     "webpack": "^5.76.2",
     "webpack-cli": "^5.0.1",
     "yarpm": "^1.2.0"
-  }
+  },
+  "dependencies": {}
 }

src/ast/classconstant.js

@@ -19,6 +19,7 @@ const IS_PRIVATE = "private";
  * @memberOf module:php-parser
  * @extends {ConstantStatement}
  * @property {string} visibility
+ * @property {bool} final
  * @property {AttrGroup[]} attrGroups
  */
 const ClassConstant = ConstantStatement.extends(
@@ -51,6 +52,7 @@ ClassConstant.prototype.parseFlags = function (flags) {
   } else if (flags[0] === 2) {
     this.visibility = IS_PRIVATE;
   }
+  this.final = flags[2] === 2;
 };
 
 module.exports = ClassConstant;

test/snapshot/__snapshots__/acid.test.js.snap

@@ -811,6 +811,7 @@ Program {
                   },
                 },
               ],
+              "final": false,
               "kind": "classconstant",
               "loc": Location {
                 "end": Position {

test/snapshot/__snapshots__/attributes.test.js.snap

@@ -333,6 +333,7 @@ Program {
               },
             },
           ],
+          "final": false,
           "kind": "classconstant",
           "visibility": "",
         },
@@ -521,6 +522,7 @@ Program {
               },
             },
           ],
+          "final": false,
           "kind": "classconstant",
           "visibility": "",
         },

test/snapshot/__snapshots__/class.test.js.snap

@@ -162,6 +162,7 @@ Program {
               },
             },
           ],
+          "final": false,
           "kind": "classconstant",
           "leadingComments": [
             CommentLine {
@@ -229,6 +230,7 @@ Program {
               },
             },
           ],
+          "final": false,
           "kind": "classconstant",
           "leadingComments": [
             CommentLine {
@@ -1334,6 +1336,7 @@ Program {
               },
             },
           ],
+          "final": false,
           "kind": "classconstant",
           "visibility": "",
         },
@@ -1443,6 +1446,7 @@ Program {
               },
             },
           ],
+          "final": false,
           "kind": "classconstant",
           "visibility": "",
         },

test/snapshot/__snapshots__/classconstant.test.js.snap

@@ -1,5 +1,52 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`classconstant final 1`] = `
+Program {
+  "children": [
+    Class {
+      "attrGroups": [],
+      "body": [
+        ClassConstant {
+          "attrGroups": [],
+          "constants": [
+            Constant {
+              "kind": "constant",
+              "name": Identifier {
+                "kind": "identifier",
+                "name": "CONSTANT",
+              },
+              "value": String {
+                "isDoubleQuote": true,
+                "kind": "string",
+                "raw": ""Hello world!"",
+                "unicode": false,
+                "value": "Hello world!",
+              },
+            },
+          ],
+          "final": true,
+          "kind": "classconstant",
+          "visibility": "public",
+        },
+      ],
+      "extends": null,
+      "implements": null,
+      "isAbstract": false,
+      "isAnonymous": false,
+      "isFinal": false,
+      "isReadonly": false,
+      "kind": "class",
+      "name": Identifier {
+        "kind": "identifier",
+        "name": "Foo",
+      },
+    },
+  ],
+  "errors": [],
+  "kind": "program",
+}
+`;
+
 exports[`classconstant multiple 1`] = `
 Program {
   "children": [
@@ -38,6 +85,7 @@ Program {
               },
             },
           ],
+          "final": false,
           "kind": "classconstant",
           "visibility": "",
         },
@@ -84,6 +132,7 @@ Program {
               },
             },
           ],
+          "final": false,
           "kind": "classconstant",
           "visibility": "private",
         },
@@ -130,6 +179,7 @@ Program {
               },
             },
           ],
+          "final": false,
           "kind": "classconstant",
           "visibility": "protected",
         },
@@ -176,6 +226,7 @@ Program {
               },
             },
           ],
+          "final": false,
           "kind": "classconstant",
           "visibility": "public",
         },
@@ -222,6 +273,7 @@ Program {
               },
             },
           ],
+          "final": false,
           "kind": "classconstant",
           "visibility": "",
         },

test/snapshot/__snapshots__/enum.test.js.snap

@@ -36,6 +36,7 @@ Program {
               },
             },
           ],
+          "final": false,
           "kind": "classconstant",
           "visibility": "public",
         },

test/snapshot/__snapshots__/heredoc.test.js.snap

@@ -1709,6 +1709,7 @@ FOOBAR",
               },
             },
           ],
+          "final": false,
           "kind": "classconstant",
           "visibility": "",
         },

test/snapshot/__snapshots__/interface.test.js.snap

@@ -65,6 +65,7 @@ Program {
               },
             },
           ],
+          "final": false,
           "kind": "classconstant",
           "visibility": "",
         },

test/snapshot/__snapshots__/nowdoc.test.js.snap

@@ -216,6 +216,7 @@ FOOBAR",
               },
             },
           ],
+          "final": false,
           "kind": "classconstant",
           "visibility": "",
         },

test/snapshot/classconstant.test.js

@@ -30,4 +30,11 @@ describe("classconstant", () => {
       parser.parseEval('class Foo { private const CONSTANT = "Hello world!"; }')
     ).toMatchSnapshot();
   });
+  it("final", () => {
+    expect(
+      parser.parseEval(
+        'class Foo { final public const CONSTANT = "Hello world!"; }'
+      )
+    ).toMatchSnapshot();
+  });
 });