No longer works with tree-sitter-php versions 0.23.0 or later

[solstag]

Ni! From version 0.23.0 tree-sitter-php no longer provides rule namespace_aliasing_clause used in current version (0.1.6) grammar.js line 514: https://github.com/claytonrcarter/tree-sitter-phpdoc/blob/v0.1.6/grammar.js#L514

In case it may be useful, I found the issue here while preparing a Guix package definition.

Cheers

[Roardom]

Hi @calebdw,

I see you removed the namespace_aliasing_clause rule here: tree-sitter/tree-sitter-php@5b47c5a

I'm not too familiar with tree-sitter grammars, but is there a replacement for this rule?

[calebdw]

@Roardom, I've fixed in #44

[claytonrcarter]

Thank you for reporting and thank you @calebdw for the fix. This is now fixed on master and tagged in v0.1.7.

[solstag]

Hi, and thank you @claytonrcarter and @calebdw. However I'm still facing an issue when building.

I've tried building with tree-sitter-php versions 0.23.0, 0.23.2 and 0.24.2.

file:///tmp/guix-build-tree-sitter-phpdoc-0.1.7.drv-0/source/[eval1]:330
        throw new Error(`Rule '${ruleName}' returned undefined.`);
              ^

Error: Rule '_type' returned undefined.
    at grammar (file:///tmp/guix-build-tree-sitter-phpdoc-0.1.7.drv-0/source/[eval1]:330:15)
    at Object.<anonymous> (/tmp/guix-build-tree-sitter-phpdoc-0.1.7.drv-0/source/grammar.js:10:18)
    at Module._compile (node:internal/modules/cjs/loader:1554:14)
    at Object..js (node:internal/modules/cjs/loader:1706:10)
    at Module.load (node:internal/modules/cjs/loader:1289:32)
    at Function._load (node:internal/modules/cjs/loader:1108:12)
    at TracingChannel.traceSync (node:diagnostics_channel:322:14)
    at wrapModuleLoad (node:internal/modules/cjs/loader:220:24)
    at cjsLoader (node:internal/modules/esm/translators:262:5)
    at ModuleWrap.<anonymous> (node:internal/modules/esm/translators:196:7)

Node.js v22.14.0
Error when generating parser

Caused by:
    Failed to load grammar.js -- `node` process exited with status 1

The rule involved and the error message are a bit different from the other case: Error: Rule '_type' returned undefined. and does not point to a specific line in phpdoc. You can see the previous error message here.

Any ideas? Should I open a different issue?

[claytonrcarter]

@solstag you're right, this was closed prematurely. This tree-sitter grammar reuses many of the grammar rules from the PHP grammar because so much of syntax of PHPDoc types are shared from PHP. This avoids us needing to redefine basic syntax here and, it was my hope, would make this grammar always align w/ the core PHP syntax.

However, my recollection is that reusing grammars like this is "off label", and it has been sort of hard to debug, such as here.

Anyway, it looks like the _type rule that we're reusing was renamed to just type in v0.22.3¹ (we currently use v0.22.2) so this should be an easy fix.

Footnotes

1. You have to view the "Files Changed" tab, and then expand the diff for common/define-grammar.js for that link to work. ↩

[claytonrcarter]

master is now updated to use v0.23 of the PHP grammar (via #45) but I'm running into problems moving to v0.24, in #46. Suggestions and help are encouraged and appreciated!

[solstag]

Great, thank you. I can confirm that with ts-php-0.23 it works for me as well. Would you mind creating a new version tag from master so I can publish a more proper package recipe? I have it working on a local channel with a commit based recipe, but a version based recipe would be preferred for inclusion in Guix.

[claytonrcarter]

@solstag I think v0.1.7 has this in it. Please confirm though

[solstag]

Thanks. I had tried v0.1.7, but it doesn't build, master does.

[claytonrcarter]

🤦 Sorry, you're right. You can try v0.1.8 now.

[solstag]

Yes, v0.1.8 builds just fine. Thank you!

[solstag]

Since there is #46 for 0.24 and this issue is about 0.23, and tree-sitter-phpdoc has been merged in Guix, I'm closing. Cheers and thanks again!