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

Line endings on windows break frontmatter in projectDocuments CLRF #2628

Closed
bukowa opened this issue Jul 7, 2024 · 3 comments
Closed

Line endings on windows break frontmatter in projectDocuments CLRF #2628

bukowa opened this issue Jul 7, 2024 · 3 comments
Labels
bug Functionality does not match expectation good first issue Easier issue for first time contributors

Comments

@bukowa
Copy link
Contributor

bukowa commented Jul 7, 2024

I don't know how much time I have wasted on debugging line endings on Windows in many projects. It's funny, for example, in Docker where if you have entrypoint.sh with CLRF it will simply tell you that "entrypoint file not found". I found a similar error in the markdown plugin for typedoc, I always come across it wherever I go. CLRF - I will probably get this tattooed :D

Search terms

Line endings on windows break frontmatter in projectDocuments CLRF

Expected Behavior

It works.

Actual Behavior

It's broken. quick_start has CLRF below:

9f5e5e3d8933a885af58fce8cf46ea2c
badbad

Steps to reproduce the bug

I added files here: https://gist.github.com/bukowa/e9623517b7e73f2494369af98185a13f#file-quick-start-html-L54
If necessary I can probably build a full example.

Environment

  • Typedoc version: 0.26.3
  • TypeScript version: 5.5.3
  • Node.js version: v22.4.0
  • OS: Windows 10
@bukowa bukowa added the bug Functionality does not match expectation label Jul 7, 2024
@Gerrit0 Gerrit0 added the good first issue Easier issue for first time contributors label Jul 8, 2024
@bukowa
Copy link
Contributor Author

bukowa commented Jul 8, 2024

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jul 8, 2024

Yep. That's it!

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jul 10, 2024

Fixed with #2631

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation good first issue Easier issue for first time contributors
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants