Psalm not allowing for inline comments in type definition about psalm HOT 6 CLOSED

I found these snippets:

<?php
/** 
 * @psalm-type LoginCredsArrayShape = array{
 * domain?: string // domain being logged into
 * }
 */

/**
 * Login Class
 */
class Login
{
}

Psalm output (using commit a75d26a):

ERROR: InvalidDocblock - 11:1 - array{ domain?: string // domain being logged into } is not a valid type: Comment lines must be terminated with a new line character (\n).

<?php
/** 
 * @psalm-type LoginCredsArrayShape = array{
 * domain?: string
 * }
 */

/**
 * Login Class
 */
class Login
{
}

Psalm output (using commit a75d26a):

No issues!

from psalm.

If someone can help point me to the right place in the code to look at this, I'd be happy to work on a pull request for it.

from psalm.

If someone can help point me to the right place in the code to look at this, I'd be happy to work on a pull request for it.

you can start debug from

from psalm.

@ging-dev Although the same error is thrown, I can't get that line to hit in the debugger (I've verified the debugger is running and breaks on the initial PHP file). Is there a cache I need to disable to get it to appropriately reanalyze files during development?

from psalm.

@ging-dev Although the same error is thrown, I can't get that line to hit in the debugger (I've verified the debugger is running and breaks on the initial PHP file). Is there a cache I need to disable to get it to appropriately reanalyze files during development?

For xdebug to work with Psalm, you need to set the environment variable PSALM_ALLOW_XDEBUG=1 when run psalm:

PSALM_ALLOW_XDEBUG=1 path/to/psalm --no-cache

For more information, see xdebug section at https://psalm.dev/docs/running_psalm/plugins/authoring_plugins/

from psalm.

My understanding is that the parser (CommentAnalyzer::splitDocLine()) skips from // until \n. But specifically for type aliases, before calling the parser, we remove all newlines:

from psalm.