Fix several bugs due to line endings not properly handled on Windows platform #216
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… which causes insidious bug like thlorenz#161
AndrewSouthpaw
requested changes
Jan 24, 2022
There was a problem hiding this comment.
Thanks for the contribution, and sorry for the slow reply!
I worry a little about this being the default behavior always. Perhaps there are Windows users out there who already have this problem solved. Or that as a Windows user perhaps they're still using the regular \r in their editors.
So my impression right now is that it isn't safe to turn on for everyone.
If you wanted, you could create a flag to enable the behavior, something like --useCRLFEndings or something. Then people could opt into it if that's their desired line endings.
| @@ -16,6 +17,28 @@ function cleanPath(path) { | |||
| return homeExpanded.replace(/\s/g, '\\ '); | |||
| } | |||
|
|
|||
| function readFile(path, encoding) { | |||
There was a problem hiding this comment.
I think a name like xFileWithCRLFHandling would be more self-documenting.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In a nut shell, this PR fixes several bugs:
Fix the bug that files on Windows always get modified by doctoc even when nothing has changed, and ultimately leading to non-usability of doctoc as pre-commit hook, elaborated on issue Unusable as 'pre-commit' hook, since it will always fail. #161.
Fix the bug that files on Windows, after modified by doctoc, inadvertently get undesirable mixed line endings.
Fix the bug that files on Windows with a TOC that has no title, are inferred by doctoc to has a TOC title that contains a single character "\r", which ultimately leads to extra line breaks.
Close #161.