fix: handle UTF-8 BOM in JSON files #1666
Open
Conversation
This file contains hidden or 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
Some editors (especially on Windows) add a UTF-8 BOM (byte order mark, U+FEFF) at the start of files. This invisible character causes JSON.parse to fail with 'Unexpected token' error. This fix detects the BOM and strips it from the file content before the JSON parser sees it, preventing the parse error.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Fixes #1631 — JSON files with UTF-8 BOM (byte order mark) cause
SyntaxError: Unexpected tokenbecause the invisible BOM character (U+FEFF) is not valid JSON.Problem
Some text editors (especially on Windows like Notepad) add a UTF-8 BOM at the start of files. This invisible character causes JSON.parse to fail:
Solution
This PR adds BOM detection and stripping before JSON parsing:
Testing
Tested by creating a JSON file with BOM - the server now starts correctly instead of throwing a parse error.