Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve line-endings for windows. #296

Merged
merged 3 commits into from
Sep 17, 2021
Merged

Improve line-endings for windows. #296

merged 3 commits into from
Sep 17, 2021

Conversation

jaapio
Copy link
Member

@jaapio jaapio commented Aug 26, 2021

Switch to internal usage of normalized line endings using \n. This make testing of the library easier and will fit most use cases. When users want to reconstruct the processed docblocks, the recommendation is to use the serializer. Which configurable with the correct line endings from this patch.

fixes #287

@jaapio jaapio force-pushed the fix/287-line-endings branch 2 times, most recently from 6684643 to 1e51a49 Compare August 26, 2021 20:13
@jaapio jaapio changed the title Test fix Improve line-endings for windows. Aug 26, 2021
@jaapio jaapio marked this pull request as ready for review August 26, 2021 20:37
@jaapio jaapio requested a review from mvriel August 26, 2021 20:37
@@ -146,7 +145,7 @@ private function lex(string $contents): array
*/
private function removeSuperfluousStartingWhitespace(string $contents): string
{
$lines = explode("\n", $contents);
$lines = Utils::pregSplit("/\r\n?|\n/", $contents);
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This an actual bugfix. windows line endings were not handled here.

@@ -96,7 +101,7 @@ public function getDocComment(DocBlock $docblock): string

$comment = $this->addTagBlock($docblock, $wrapLength, $indent, $comment);

return $comment . $indent . ' */';
return str_replace("\n", $this->lineEnding, $comment . $indent . ' */');
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

new feature :-)

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.

Tests are failing on Windows / Fix line ending handling
1 participant