Skip to content

Support "one-line" comments (starting with //)#202

Closed
rhertogh wants to merge 2 commits into
phpstan:1.22.xfrom
rhertogh:support_one_line_comments
Closed

Support "one-line" comments (starting with //)#202
rhertogh wants to merge 2 commits into
phpstan:1.22.xfrom
rhertogh:support_one_line_comments

Conversation

@rhertogh

Copy link
Copy Markdown

This PR adds support for comments inside type definitions, e.g.:

/** @return array { // Array with comments.
 *     // Comments can be placed on their own line. 
 *     foo: string, // An array key description.
 *     bar: array {, // Another array key description.
 *         'foo//bar': string, // Array key with "//" in it's name.
 *     },
 * }
 */

Fixes #184

@ondrejmirtes

Copy link
Copy Markdown
Member

Hi, thank you, I have a few points that will makes this more complicated.

  1. The comment needs to be available for each type node in the node attributes.
  2. The comments need to be correctly preserved for the format-preserving printer, meaning it will get a bit more complicated. Fortunately it's heavily inspired by the printer from nikic/PHP-Parser so we have some starting point.

@rhertogh

Copy link
Copy Markdown
Author

@ondrejmirtes

  1. The comment needs to be available for each type node in the node attributes.
  2. The comments need to be correctly preserved for the format-preserving printer, meaning it will get a bit more complicated. Fortunately it's heavily inspired by the printer from nikic/PHP-Parser so we have some starting point.

Could you point me to the locations where this should be implemented, then I'll give it a shot.

@ondrejmirtes

Copy link
Copy Markdown
Member

Comments need to be added as attributes similarly to how Attribute::START_LINE is added today. See calls to methods called enrichWithAttributes.

As for Printer, see tests in PrinterTest. Comments should be preserved correctly when printing the same PHPDoc again, and correct comment should be removed when for example removing a key from an array shape.

@shmax

shmax commented Aug 28, 2023

Copy link
Copy Markdown
Contributor

@rhertogh do you have any plans to proceed with this PR? I think it's an important feature... 🙏

@shmax

shmax commented Sep 1, 2023

Copy link
Copy Markdown
Contributor

@ondrejmirtes

In the event that @rhertogh is MIA, any chance I can prevail upon you to implement this? If you're too busy I can take a crack at it, but I have to confess I couldn't make much sense of the printer tests...

@rhertogh

rhertogh commented Sep 3, 2023

Copy link
Copy Markdown
Author

@shmax Haven't found the time to continue working on this😅. So if you want to take a swing at it please feel free to do so.

@shmax

shmax commented Sep 3, 2023

Copy link
Copy Markdown
Contributor

Okay, will do. 👍

@ondrejmirtes

Copy link
Copy Markdown
Member

Superseded by #264

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Multiline array shapes with 'comments'

3 participants