Added new option: includePositions

[mliezun]

Hi @VeryCrazyDog I'm coming here with a feature proposal.

To add a new option includePositions: bool to the split function.

When includePositions = true return start and end positions from the original source of text from which the statement was parsed.

This is helpful to compare what was the original query and the resulting query that is going to be executed after parsing.

What was done:

• Correctly track and return positions for parsed statements.
• Added test to check that it works correctly.

Thanks again for your work and for this package 👍

[VeryCrazyDog]

Partially reviewed the code, please expect more comments may be added after PR revised.

[VeryCrazyDog]

The word position is too generic, and not align with the existing source code naming of using index. Consider either one of the below:

1. Rename it to unreadIndex and add JSDoc to document that it is the index in source SQL string.
2. Rename it to unreadSourceFileIndex.

[mliezun]

Renamed to unreadSourceFileIndex

[VeryCrazyDog]

I am open for including support of includePositions options, but not in a way that introduce breaking changes. Instead of altering existing split function, add a new function instead.

function splitIncludeSourceMap (sql: string, options?: SplitOptions): Array<{ stmt: string, start: number, end: number }>;

[mliezun]

Created new function splitIncludeSourceMap ✅

[VeryCrazyDog]

Please avoid unnecessary reordering of functions in feature or bugfix PRs. These changes can complicate code reviews, as the diffs become harder to follow.

It would be better to keep the code in its original position and create a separate PR for any rearrangements.

[mliezun]

Done ✅

[VeryCrazyDog]

Why this comment is removed?

[mliezun]

I thought maybe it was not needed because nothing was done about it. Put the comment back in place ✅

[mliezun]

Addressed all your comments. Think it looks a lot more streamlined now and the changes are easier to follow.

Thanks for your review!!