Structural search and replace

Search for a target structurally

1. In the main menu, go to Edit | Find | Search Structurally to open the Structural Search dialog.

   To quickly switch to the Structural Replace dialog, click .

2. In the Structural Search dialog, do one of the following:

   • Create a template from scratch: select Draft Template from the list of templates and enter the code template (for example, $variable$ to represent your code) in the editor area.

     To save your custom template for future use, click the Save Template icon () on the dialog toolbar. You can also choose to save the template as an inspection.

     

     GoLand adds the created template to the Recent node in the template list.

   • Use one of the existing templates to act as a prototype: select the necessary template from the list of available existing templates.

     For example, consider the following code snippet:

     package company import ( "fmt" "regexp" ) type Employee struct { NAME string Age int Salary float64 Email string } type Manager struct { Employee Department string } type Documents struct { Passport int SocSecurity string IDCard string BirthCert string } type Department struct { Name string Manager *Manager Employees []Employee } func (e *Employee) Work() { fmt.Printf("%s is working.\n", e.NAME) } func (e *Employee) GetDetails() string { return fmt.Sprintf("Employee: %s, Age: %d, Salary: %.2f, Email: %s", e.NAME, e.Age, e.Salary, e.Email) } func (e *Employee) IsValidEmail() bool { var emailRegex = regexp.MustCompile(`^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$`) return emailRegex.MatchString(e.Email) }

     Let's find a struct that has four fields, with the first one starting with an uppercase letter.

     From the list of existing templates, navigate to Go | Declarations and select Struct Declaration. GoLand will instantly highlight the matching constructs in the editor if they are present in the opened file.

     Click Find to search for these constructions in the entire project.

     

3. The Structural Search dialog shows the selected template and the values of its filters. You can edit existing filters or add new conditions, such as regular expressions or script constraints. Place the caret on a code variable and use the filter area to manage its filters.

   For example, you can change the Count modifier of the $field$ variable and set its Max value to 3. The highlighted results are now limited by this setting and should include no more than three fields.

   

   Alternatively, for a more granular search, you can change the search template to:

   type $name$ struct { $field$ $fieldType$ $field1$ $field1Type$ $field2$ $field2Type$ $field3$ $field3Type$ }

4. In this example, add a Text modifier for the $field$ variable.

5. For the Text modifier, enter the following regular expression:

   \b[A-Za-z]*[A-Z]{2,}[A-Za-z]*\b

   In this case GoLand searches only for structs with uppercase characters in the first field.

   

   There are also additional options available depending on the selected language.

   For example, review the following options:

   • Language: use the list to select which file types to include in the search. In this case, it is Go.

   • Target: use the list to select what item to search for.

   • Injected code: if selected, injected code such as JavaScript in HTML or SQL in Java is included in the search.

   • Match case: if selected, the search results match the case of the search target.

6. Specify the search scope: a project, module, directory, or a custom scope.

7. Click Find.

   GoLand shows the results in the Find tool window.

   

   You can add the new search template to structural search inspections as a custom template. To do this, click Create Inspection from Template in the Find tool window. You can then reuse it to inspect your code.

Share search templates

You can share a search template with your peers by exporting or importing it.

1. In the Structural Search dialog (Edit | Find | Search Structurally), create a new search template or use the existing one.

2. To export a template, click . GoLand adds the XML representation of the template to a clipboard (press Ctrl+Shift+V to see the clipboard's content). You can share this representation with other developers in chat, email, or a forum.

   To import a template, copy (Ctrl+C) the shared XML code from anywhere (email, chat, or a forum) and in the Structural Search dialog, click . GoLand takes the XML code representation and converts it into a template including variables and a scope if it is present.