search

mattpocock / ts-error-translator

VSCode extension to turn TypeScript errors into plain English
https://ts-error-translator.vercel.app
2.35k stars 90 forks source link

(fix): [engine] Properly calculate `endIndex` in `parseError` #268

Open dmmulroy opened 4 months ago

dmmulroy commented 4 months ago

Currently the parseError function in parseErrors.ts is incorrectly calculating the endIndex of each match.

The code currently is written as:

        const startIndex = message.indexOf(matchElem);
        const endIndex = startIndex ?? 0 + matchElem.length;

This causing endIndex to always equal startIndex. The use of ?? was likely used to satisfy the TypeScript compiler as indexOf can return undefined. However, since we know that matchElem will aways be in message (it comes from regexp match) it'll never actually be undefined.

This has the consequence of startIndex always being truthy and never evaluating ?? 0 + matchElem.length

This PR changes the code to:

        const startIndex = message.indexOf(matchElem) ?? 0;
        const endIndex = startIndex + matchElem.length;

In addition, I added a test for this and updated the snapshot tests. Happy to make any additional changes!

changeset-bot[bot] commented 4 months ago

⚠️ No Changeset found

Latest commit: c6ad317828515c665f6f0f6efb8e3aa90e7ba3a7

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR