fix(parser): override data.context.kind if member kind is unknown

- can occur when an identifier is a keyword

Signed-off-by: Lexus Drumgold <[email protected]>

Author: unicornware

__fixtures__/coordinate-pair.ts

@@ -9,12 +9,23 @@ import type Coordinate from './coordinate'
  * Pair of numbers representing a single point on a two-dimensional grid.
  */
 interface CoordinatePair {
+  /**
+   * Error handler.
+   *
+   * @param {Error} error - Error to handle
+   * @return {void} Nothing when complete
+   */
+  catch?(error: Error): void
+
   /** x-coordinate. */
   x: Coordinate
 
   /** y-coordinate. */
   y: Coordinate
 
+  /** Coordinate type. */
+  type?: string
+
   /**
    * Returns a string representation of the coordinate.
    *

package.json

@@ -68,6 +68,7 @@
     "@flex-development/tutils": "5.0.1",
     "detab": "3.0.1",
     "unist-builder": "3.0.0",
+    "unist-util-source": "4.0.1",
     "vfile": "5.3.5",
     "vfile-location": "4.0.1"
   },

src/__snapshots__/attacher.functional.snap

@@ -437,7 +437,7 @@ root[2]
 `;
 
 exports[`functional:attacher > should create ast for interface declaration 1`] = `
-root[5]
+root[7]
 │ data: {}
 ├─0 comment[2] (1:1-4:4, 0-77)
 │   │ data: {"context":null,"value":"/**\\n * @file Fixtures - CoordinatePair\\n * @module fixtures/CoordinatePair\\n */"}
@@ -446,22 +446,34 @@ root[5]
 │   └─1 block-tag[0] (3:4-3:35, 42-73)
 │         data: {"tag":"@module","text":"fixtures/CoordinatePair","value":"@module fixtures/CoordinatePair"}
 ├─1 comment[1] (8:1-10:4, 123-204)
-│   │ data: {"context":{"identifier":"CoordinatePair","kind":"interface","members":["x","y","toString"],"modifiers":[],"parent":null,"position":{"end":{"line":24,"column":2,"offset":465},"start":{"line":11,"column":1,"offset":205}}},"value":"/**\\n * Pair of numbers representing a single point on a two-dimensional grid.\\n */"}
+│   │ data: {"context":{"identifier":"CoordinatePair","kind":"interface","members":["catch","x","y","type","toString"],"modifiers":[],"parent":null,"position":{"end":{"line":35,"column":2,"offset":661},"start":{"line":11,"column":1,"offset":205}}},"value":"/**\\n * Pair of numbers representing a single point on a two-dimensional grid.\\n */"}
 │   └─0 implicit-description[0] (9:4-9:74, 130-200)
 │         data: {"value":"Pair of numbers representing a single point on a two-dimensional grid."}
-├─2 comment[1] (12:3-12:23, 234-254)
-│   │ data: {"context":{"identifier":"x","kind":"property-signature","members":[],"modifiers":[],"parent":"CoordinatePair","position":{"end":{"line":13,"column":16,"offset":270},"start":{"line":13,"column":3,"offset":257}}},"value":"/** x-coordinate. */"}
-│   └─0 implicit-description[0] (12:7-12:20, 238-251)
+├─2 comment[3] (12:3-17:6, 234-354)
+│   │ data: {"context":{"identifier":"catch","kind":"method-signature","members":[],"modifiers":[],"parent":"CoordinatePair","position":{"end":{"line":18,"column":29,"offset":383},"start":{"line":18,"column":3,"offset":357}}},"value":"/**\\n   * Error handler.\\n   *\\n   * @param {Error} error - Error to handle\\n   * @return {void} Nothing when complete\\n   */"}
+│   ├─0 implicit-description[0] (13:6-13:20, 243-257)
+│   │     data: {"value":"Error handler."}
+│   ├─1 block-tag[0] (15:6-15:44, 268-306)
+│   │     data: {"tag":"@param","text":"{Error} error - Error to handle","value":"@param {Error} error - Error to handle"}
+│   └─2 block-tag[0] (16:6-16:42, 312-348)
+│         data: {"tag":"@return","text":"{void} Nothing when complete","value":"@return {void} Nothing when complete"}
+├─3 comment[1] (20:3-20:23, 387-407)
+│   │ data: {"context":{"identifier":"x","kind":"property-signature","members":[],"modifiers":[],"parent":"CoordinatePair","position":{"end":{"line":21,"column":16,"offset":423},"start":{"line":21,"column":3,"offset":410}}},"value":"/** x-coordinate. */"}
+│   └─0 implicit-description[0] (20:7-20:20, 391-404)
 │         data: {"value":"x-coordinate."}
-├─3 comment[1] (15:3-15:23, 274-294)
-│   │ data: {"context":{"identifier":"y","kind":"property-signature","members":[],"modifiers":[],"parent":"CoordinatePair","position":{"end":{"line":16,"column":16,"offset":310},"start":{"line":16,"column":3,"offset":297}}},"value":"/** y-coordinate. */"}
-│   └─0 implicit-description[0] (15:7-15:20, 278-291)
+├─4 comment[1] (23:3-23:23, 427-447)
+│   │ data: {"context":{"identifier":"y","kind":"property-signature","members":[],"modifiers":[],"parent":"CoordinatePair","position":{"end":{"line":24,"column":16,"offset":463},"start":{"line":24,"column":3,"offset":450}}},"value":"/** y-coordinate. */"}
+│   └─0 implicit-description[0] (23:7-23:20, 431-444)
 │         data: {"value":"y-coordinate."}
-└─4 comment[2] (18:3-22:6, 314-442)
-    │ data: {"context":{"identifier":"toString","kind":"method-signature","members":[],"modifiers":[],"parent":"CoordinatePair","position":{"end":{"line":23,"column":21,"offset":463},"start":{"line":23,"column":3,"offset":445}}},"value":"/**\\n   * Returns a string representation of the coordinate.\\n   *\\n   * @return {string} String representation of coordinate\\n   */"}
-    ├─0 implicit-description[0] (19:6-19:56, 323-373)
+├─5 comment[1] (26:3-26:26, 467-490)
+│   │ data: {"context":{"identifier":"type","kind":"property-signature","members":[],"modifiers":[],"parent":"CoordinatePair","position":{"end":{"line":27,"column":16,"offset":506},"start":{"line":27,"column":3,"offset":493}}},"value":"/** Coordinate type. */"}
+│   └─0 implicit-description[0] (26:7-26:23, 471-487)
+│         data: {"value":"Coordinate type."}
+└─6 comment[2] (29:3-33:6, 510-638)
+    │ data: {"context":{"identifier":"toString","kind":"method-signature","members":[],"modifiers":[],"parent":"CoordinatePair","position":{"end":{"line":34,"column":21,"offset":659},"start":{"line":34,"column":3,"offset":641}}},"value":"/**\\n   * Returns a string representation of the coordinate.\\n   *\\n   * @return {string} String representation of coordinate\\n   */"}
+    ├─0 implicit-description[0] (30:6-30:56, 519-569)
     │     data: {"value":"Returns a string representation of the coordinate."}
-    └─1 block-tag[0] (21:6-21:58, 384-436)
+    └─1 block-tag[0] (32:6-32:58, 580-632)
           data: {"tag":"@return","text":"{string} String representation of coordinate","value":"@return {string} String representation of coordinate"}
 `;
 

src/parser.ts

@@ -5,7 +5,9 @@
 
 import type { Nullable } from '@flex-development/tutils'
 import { detab } from 'detab'
+import type { Node, Position } from 'unist'
 import { u } from 'unist-builder'
+import { source } from 'unist-util-source'
 import type { VFile } from 'vfile'
 import { location } from 'vfile-location'
 import type { Context } from './data'
@@ -395,6 +397,29 @@ class Parser extends AbstractParser<Root> {
 
             // exactly one ident over => member
             if (n.position.start.column === start.column + indent_size) {
+              // override unknown member kind
+              // this can happen when a member's identifier is a keyword
+              if (n.data.context?.kind === Kind.UNKNOWN) {
+                const { position } = n.data.context
+
+                /**
+                 * Declaration source code.
+                 *
+                 * @const {string} source
+                 */
+                const source: string = this.source(position)!
+
+                // reset unknown member kind
+                switch (true) {
+                  case !!METHOD_REGEX.exec(source):
+                    n.data.context.kind = 'method' as Kind
+                    break
+                  case !!MEMBER_OR_PROPERTY_REGEX.exec(source):
+                    n.data.context.kind = 'property' as Kind
+                    break
+                }
+              }
+
               // ensure member kind is Kind
               switch (n.data.context?.kind) {
                 case 'method' as Kind:
@@ -548,6 +573,20 @@ class Parser extends AbstractParser<Root> {
     }
   }
 
+  /**
+   * Retrieves the source code of a node or position.
+   *
+   * @see https://github.com/syntax-tree/unist-util-source
+   *
+   * @protected
+   *
+   * @param {Node | Position} value - Node or position
+   * @return {Nullable<string>} Source code or `null`
+   */
+  protected source(value: Node | Position): Nullable<string> {
+    return source(value, this.file)
+  }
+
   /**
    * Removes comment delimiters (`/**`, `*\/`, ` * `) from `value`.
    *

yarn.lock

@@ -861,6 +861,7 @@ __metadata:
     unified: "npm:10.1.2"
     unist-builder: "npm:3.0.0"
     unist-util-inspect: "npm:7.0.1"
+    unist-util-source: "npm:4.0.1"
     version-bump-prompt: "npm:6.1.0"
     vfile: "npm:5.3.5"
     vfile-location: "npm:4.0.1"
@@ -7900,6 +7901,17 @@ __metadata:
   languageName: node
   linkType: hard
 
+"unist-util-source@npm:4.0.1":
+  version: 4.0.1
+  resolution: "unist-util-source@npm:4.0.1"
+  dependencies:
+    "@types/unist": "npm:^2.0.0"
+    vfile: "npm:^5.0.0"
+    vfile-location: "npm:^4.0.0"
+  checksum: 926c41a1c472eadeadbe0712ca3e97492db2d0c8f5cc079eb62e4fcf9d85eab2c90d52d57d180e1275ac911a9afcf29eb947bb5b6e0981df26eacf3ff2d8fd13
+  languageName: node
+  linkType: hard
+
 "unist-util-stringify-position@npm:^2.0.0":
   version: 2.0.3
   resolution: "unist-util-stringify-position@npm:2.0.3"
@@ -8030,7 +8042,7 @@ __metadata:
   languageName: node
   linkType: hard
 
-"vfile-location@npm:4.0.1":
+"vfile-location@npm:4.0.1, vfile-location@npm:^4.0.0":
   version: 4.0.1
   resolution: "vfile-location@npm:4.0.1"
   dependencies: