fix: Account for BOM in the processor #282
Merged
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
mdjermanovic
commented
Sep 13, 2024
tests/processor.test.js
Outdated
Comment on lines
838
to
844
| it("should translate indented column numbers", () => { | ||
| const result = processor.postprocess(messages); | ||
|
|
||
| assert.strictEqual(result[2].column, 9); | ||
| assert.strictEqual(result[3].column, 4); | ||
| assert.strictEqual(result[4].column, 2); | ||
| }); |
There was a problem hiding this comment.
This is the only test that was failing with BOM before the code change.
tests/processor.test.js
Outdated
Comment on lines
846
to
851
| it("should adjust fix range properties", () => { | ||
| const result = processor.postprocess(messages); | ||
|
|
||
| assert(result[2].fix.range, [185, 185]); | ||
| assert(result[4].fix.range, [264, 265]); | ||
| }); |
There was a problem hiding this comment.
I'm not sure how, but this test was passing with BOM before the code change.
There was a problem hiding this comment.
Oh, this test was missing .deepStrictEqual after assert.
There was a problem hiding this comment.
Ok, in 68aede7 I fixed this test and added another one as per the repro from the original post. Both would fail without the code change.
Merged
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.
The processor doesn't account for BOM, which would be passed in by ESLint if the file has it.
This causes incorrect adjustments of locations and fix ranges.
Repro: https://github.com/mdjermanovic/eslint-markdown-bom
In the above repro,
space-in-parensrule fixes( a)to( )instead of(a).This PR updates
preprocess()to remove BOM from the text it operates on.