Extension for custom tags

Open
#178 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
38/100
Issue type
Feature
Clarity
Needs clarification
Activity status
Active
Tech stack
php
Domain
devtools

Research direction

Start by tracing how PhpDoc input containing custom tags is parsed and where it currently fails before reaching TypeNodeResolverExtension. Define the parser and extension behavior needed for tuple and shape tags, then verify that those tags reach the extension's resolve call without breaking existing PhpDoc parsing.

Written by the indexing model from the issue text.

Description

Description

It would be cool to see the extension for custom tags.

We have our own tags that describe Array shapes as in PhpStan:

/**
 * @param tuple(T1, T2, ..., Tn) $tuple
 * @param shape(k1:T1, k2:T2, ..., kn:Tn) $shape
 */
Why?

I want to make an extension for PhpStan, which through TypeNodeResolverExtension, would be able to tell what type is here.

Problem

At the moment, the problem occurs while parsing a PhpDoc and does not reach the resolve call of TypeNodeResolverExtension.

Dominant language
PHP
Stars
1.5k
Forks
78
Avg merge
9h 5m
Merged PRs (30d)
5

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from phpstan/phpdoc-parser

All issues in phpstan/phpdoc-parser

Similar issues

More PHP issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.