Refactor comment skipping

[kekavc24]

This PR improves #90 further by:

1. Lazily looking ahead for comments and aligns skipAndExtractComments with existing YamlEditor behaviour. The function now reverts back to the first line break it encountered when it looked ahead for comments by default
2. Allowing callers of skipAndExtractComments to explicitly specify whether it should greedily look ahead for comments.
3. Preventing the trailing line break for YamlScalars with the ScalarStyles plain, any, folded or literal from being pruned (may need additional tests to disprove ScalarStyle.PLAIN or ScalarStye.ANY)

Further changes made in #94

---

• I’ve reviewed the contributor guide and applied the relevant portions to this PR.

Contribution guidelines:

• See our contributor guide for general expectations for PRs.
• Larger or significant changes should be discussed in an issue before creating a PR.
• Contributions to our repos should follow the Dart style guide and use dart format.
• Most changes should add an entry to the changelog and may need to rev the pubspec package version.
• Changes to packages require corresponding tests.

Note that many Dart repos have a weekly cadence for reviewing PRs - please allow for some latency before initial review feedback.