Update: indent comments w/ nearby code if no blank lines (fixes #9733)

[platinumazure]

Also needed to ensure that comments between element lists have desired offsets set if first element is on same line as beginning of element list

What is the purpose of this pull request? (put an "X" next to item)

[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[x] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

See issue #9733.

What changes did you make? (Give an overview)

Ensure that comments (which are the first or sole content of a line) can only line up with preceding or following tokens if those tokens are on the immediately previous line. Otherwise, comments must be in "correct" location.

Fixing this exposed an issue in addElementListIndent where, when second and later elements in an element list need to be aligned with the first element and the first element begins on the same line as the containing node, comment tokens between the elements also must have offsets explicitly specified as being relative to the first element's first token. (An example of where this issue would have manifested can be found here: The test cases in this file are all aligned with the list container, but the comment's desired offset was still 4 spaces to the right from there. This wasn't an issue before I wrote this PR, because the comment indent fallback logic was allowing it to anchor to the tokens 2 lines above or below.)

Although the issue was accepted as a bug, I know this could increase warnings, so I've committed this as an "Update".

Is there anything you'd like reviewers to focus on?

• Are there any more test cases I should add? (Especially for the addElementListIndent change.)
• Could I replace the hasBlankLinesBetween function with other helper functions (e.g., countTrailingLinebreaks) to improve maintainabillity?

[not-an-aardvark]

LGTM, thanks!

[not-an-aardvark]

Actually I have a small nitpick, but it's not a blocker.

[not-an-aardvark]

Could this be combined with the line above into something like this instead?

offsets.setDesiredOffsets(
    [previousElement.range[1], element.range[1]],
    firstTokenOfPreviousElement,
    0
);

offsets.setDesiredOffsets accepts a text range as the first argument, and modifies the indentation of all tokens in that range, without needing to iterate over all of those tokens. So it's not necessary to call it multiple times on separate consecutive tokens, and doing so ends up being slightly worse for performance (although it's unlikely to matter much in this case since users probably don't have large numbers of consecutive comments between elements).

[platinumazure]

@not-an-aardvark I've incorporated your feedback. Let me know if you see any other issues. Thanks!