Order lint diagnostics by source location in the Studio webview

[RitoG09]

Problem

Lint diagnostics in the Studio webview are currently rendered in the order they are received, which can feel inconsistent for larger schemas.

Proposal

Introduce deterministic ordering for lint diagnostics rendered in the Studio webview, based on their source location:

• Primary sort by line number

Benefits

• Predictable and consistent presentation of diagnostics
• Easier navigation for users reviewing multiple issues
• No changes to linting logic or VS Code behavior

Screenshot

[RitoG09]

@jviotti @Karan-Palan Any thoughts on this?

[jviotti]

@RitoG09 Happy to give it a shot at the extension level. My suggestion is:

• Order by line number
• Leave a TODO comment suggesting that maybe we should do this in the CLI instead
• An e2e test that proves the ordering?

The reason for my second point is that the extension already loads until all linting issues are there while the CLI prints them as it goes, which is useful for massive schemas. Maybe there is a way to do it internally in the linter transformer level, but not sure. At least the extension part seems like a low hanging fruit.

Feel free to send a PR!