Introduction to type-aware code search
Imagine you're an author of a Java library. You've defined an abstract base class and you want to figure out if people are using a specific method defined in that class. It wouldn't be too difficult to search in the repository where the class was defined, but what if there are hundreds or thousands of repositories that are potentially using it or some subclass of it? Searching for the method name might return thousands of irrelevant matches. A human would certainly struggle to do this search within a reasonable amount of time.
Fortunately, Moderne offers a robust solution to this problem: type-aware search recipes. Using these recipes you can quickly and correctly find things like classes, methods, or fields — even if they are named or imported in different ways.
To help you get accustomed to Moderne's search capabilities, in this guide, we will:
As an example, let's say that you are wanting to find all of the places where your team is using the
createFile method from java.nio.file.Files. Maybe there is a security issue with it and you want to find out where it's being used to determine how hard it is to replace it. Or maybe you just want to learn how to use it for yourself in another area.If you searched for
createFile in GitHub, you might end up with a ton of irrelevant results as this is a fairly common method name. To find results that match the method name and are from the correct library, please follow these steps:
- Click on the wand icon next to the method pattern textbox to open the method pattern wizard.
- Enter the fully qualified class name of
java.nio.file.Filesin the fully qualified receiver type field. - Enter the method name of
createFilein the method name field. - Enter
..in the argument type field to denote that we want to search for any amount of arguments (zero or more). - Press
Applyto add the method pattern to the text box.
The combination of the fully qualified receiver type, the method name, and the argument types make up a "method pattern".
For extensive documentation on each of these components and more examples of different ways you can use method patterns to search for methods, please check out the OpenRewrite docs.
- Your window should look like:
- Press
Dry Runto begin the search. You will be redirected to a page that looks like:
As the code in the SaaS is constantly changing, your results will more than likely be different.
- If you click on one of the repository names such as
eclipse/winery, you'll be taken into the code for that repository. Lines that match the search will be underlined and marked with a magnifying glass icon. These lines match the type that was specified in the search. This means that if any othercreateFilemethod was invoked, you wouldn't see those results here. Instead, you will see:
From there, you can make intelligent decisions about the code. For instance, maybe you'll see that there aren't too many instances of this and conclude that you can safely replace it with a new
createFile method. Or maybe you just wanted to learn how other people use it to safely use it in your new class. Regardless of what you end up doing, you can be confident that you correctly and quickly found all of the places that use this method.To discover all of the type-aware search recipes, please follow these steps:
- Click on
Search:
- You will then arrive on a page that includes recipes for all of the different ways you can search for code:
- Click on whichever one you are interested in exploring.