Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions grammar.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ const PHP = require('tree-sitter-php/php/grammar').grammar;
// TODO array return types https://docs.phpdoc.org/3.0/guide/references/phpdoc/types.html#arrays
// @verbatimElement [required element] [<optional element>]

// console.error(JSON.stringify(PHP.reserved.classes[0]));
// console.error(PHP.reserved.classes[0].value);

module.exports = grammar({
name: 'phpdoc',

Expand All @@ -33,6 +36,13 @@ module.exports = grammar({
[$.union_type, $.disjunctive_normal_form_type],
],

// copied to mimic the PHP grammar
reserved: {
global: (_) => PHP.reserved.global.map((k) => new RegExp(k.value, 'i')),
classes: (_) => PHP.reserved.classes.map((k) => new RegExp(k.value, 'i')),
nothing: (_) => [],
},

// Note:
// 1. External scanners receive text with `extras` not removed yet. So
// whitespace must be detected and skipped appropriately with lexer->skip().
Expand Down Expand Up @@ -481,7 +491,7 @@ module.exports = grammar({
$.tag_name,
),
// @psalm-trace [name]
seq(alias(choice('@psalm-trace'), $.tag_name), $.variable_name),
seq(alias('@psalm-trace', $.tag_name), $.variable_name),
seq(
alias(choice('@param-out', '@psalm-param-out'), $.tag_name),
$._type,
Expand All @@ -498,10 +508,8 @@ module.exports = grammar({
$.tag_name,
),
$._type,
choice(
$.variable_name,
// TODO allow PHP expression
),
$.variable_name,
// TODO allow PHP expression
),
//TODO implement @psalm-taint-* see https://psalm.dev/docs/security_analysis/annotations/
seq(
Expand Down
42 changes: 24 additions & 18 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,15 @@
"devDependencies": {
"prebuildify": "^6.0.0",
"prettier": "^3.3.3",
"tree-sitter-cli": "^0.22.6",
"tree-sitter-php": "^0.23.12"
"tree-sitter-cli": "^0.25.10",
"tree-sitter-php": "^0.24.2"
},
"dependencies": {
"node-addon-api": "^7.1.0",
"node-gyp-build": "^4.8.0"
},
"peerDependencies": {
"tree-sitter": "^0.21.0"
"tree-sitter": "^0.22.0"
},
"peerDependenciesMeta": {
"tree_sitter": {
Expand Down
32 changes: 32 additions & 0 deletions tree-sitter.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
{
"grammars": [
{
"name": "phpdoc",
"camelcase": "PHPDoc",
"scope": "source.php",
"path": "php",
"file-types": ["php"]
}
],
"metadata": {
"version": "0.1.8",
"license": "MIT",
"description": "PHPDoc grammar for tree-sitter",
"authors": [
{
"name": "Clayton Carter"
}
],
"links": {
"repository": "https://github.com/claytonrcarter/tree-sitter-phpdoc"
}
},
"bindings": {
"c": true,
"go": false,
"node": true,
"python": true,
"rust": true,
"swift": true
}
}
Loading