Inconsistent output due to os EOL

Open
#289 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
typescript
Domain
documentation

Research direction

Start with the linked reproduction at https://github.com/eps1lon/issue-react-docgen-windows-eol and trace how react-docgen reads and emits source text. Check the behavior on different operating-system line endings; done means the output preserves the input file's original EOL style instead of using the system-wide setting.

Written by the indexing model from the issue text.

Description

bug

react-docgen ignores original line-endings in the file and replaces them with the system wide EOL setting.

Repro: https://github.com/eps1lon/issue-react-docgen-windows-eol

Dominant language
TypeScript
Stars
3.8k
Forks
316
Avg merge
3h 28m
Merged PRs (30d)
6

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from reactjs/react-docgen

All issues in reactjs/react-docgen

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.