prettier / prettier/plugin-php
Heredoc containing \n cannot be parsed for indenting
Open
Nobody has claimed this yet.
bug
- Dominant language
- PHP
- Stars
- 1.9k
- Forks
- 139
- PR merge metrics
- No merged PRs in 30d
Description
Input:
<?php
function foo() {
$message .= <<<EOT
Please read this message.\n We apologize for the inconvenience.
EOT;
}
Output:
Invalid body indentation level (expecting an indentation at least 4) on line 5
3 | $message .= <<<EOT
4 | Please read this message.\n We apologize for the inconvenience.
> 5 | EOT;
| ^
6 | }
7 |
Expected:
<?php
function foo() {
$message .= <<<EOT
Please read this message.\n We apologize for the inconvenience.
EOT;
}
Basically, the \n in the middle of the heredoc appears to confuse either the parser or prettier.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked Prettier PHP Playground and reproduce the heredoc case containing the literal \n. Trace whether parsing or indentation validation mishandles that content, then add a regression test for the example. Done means the input formats successfully without an indentation error and preserves the expected heredoc output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- php
- Domain
- tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100