reactjs / reactjs/react-docgen
Inconsistent output due to os EOL
Open
Nobody has claimed this yet.
bug
- Dominant language
- TypeScript
- Stars
- 3.8k
- Forks
- 316
- Avg merge
- 5h 7m
- Merged PRs (30d)
- 4
Description
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
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 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.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100