Support Locating AST elements by Line/Column

[JLLeitschuh]

This allows for finding AST nodes that are flagged by other scanners to be identified within the OpenRewrite Java AST.

Unfortunately, since each printer is unique to each language, this logic as it is currently is not multi-language

Signed-off-by: Jonathan Leitschuh [email protected]

[JLLeitschuh]

@timtebeek is this something that would be desired in rewrite-java or is this the appropriate home for it?

[knutwannheden]

I think this could go into rewrite-java. What is your use case for this?

[knutwannheden]

Also, I think if this is something we may also want for other source types, that would be another candidate for something like a SourceFileService as in the following PR: openrewrite/rewrite#3817

Up until now I have been reluctant to add this, because we are still lacking use cases for it.

[JLLeitschuh]

What is your use case for this?

Matching up OpenRewrite AST nodes with those from security scanners, for examples SARIF files generated by CodeQL

[JLLeitschuh]

Do you have a better name for this utility than CoordinateLocator? LineColumnLocator was another name I considered. Thoughts?

[knutwannheden]

Coordinate is insofar a bit unfortunate, as this term is already used in a different situation. Maybe something with "source file offset" or "element" (referring to the LST element)? But naming things isn't my strength either 😄

[jkschneider]

Indeed, we already have an OpenRewrite concept of Coordinates, so the naming overlap is not good. In the IDE it is called "Go to Line" but also involves a column. So GoToLine seems reasonable to me here as well.

Please don't have the public API signature return FJ types. We are trying to get away from FJ.

[JLLeitschuh]

Please don't have the public API signature return FJ types.

Good point. I think the method type singnature was generated by GitHub copilot and I just went with it, I should have spotted that change. Will change types

[JLLeitschuh]

Should finding AST elements by line/column be in core or in rewrite-java? This seems like it's likely something that we'd want to be available to all languages, eventually. But maybe starting with a smaller scope initially is better? @jkschneider what are your thoughts?

[JLLeitschuh]

Superseded by: openrewrite/rewrite#3829