Offer rename refactoring of Rascal identifiers

[DavyLandman]

Is your feature request related to a problem? Please describe.
I want to have rename refactoring work for rascal.

When I as a user trigger rename on:

• function
• variable
• module name

I want rascal to calculate the correct rename operation based on whats currently open in the workspace.

Describe the solution you'd like
LSP has a dedicated api for rename. To pace our development, I would like to have support for rename first, and to the generic refactorings in a later stage. Similarly, if needed, we can split the support for rascal vs the support for DSLs.

Ideally the rename command is executed in a similar way as outline is done, we have rascal code that is invoked by the rascal-lsp server.

Describe alternatives you've considered

• write the refactoring in Java: would be a bad idea, will be quite verbose
• create a generic refactoring framework that models any refactoring of LSP to rascal, such that we can leverage that: too much work as an initial addition. First get rename right, use that implementation to learn how to do the rest.

Additional context
Good news is that we already have TextEdits in Rascal, which map cleanly on the edits that LSP needs.

[jurgenvinju]

Textedits also cover file renamings, so that's cool if we change a module name

[jurgenvinju]

It would be best if we can reuse information generated by the type-checker; for example the summaries, collect them for all modules in a project and then reverse the references.

I would limit the current functionality to within a current project and push cross project uses/renamings to an enhancement issue. We don't even have cross-project incremental type-checking

[toinehartman]

Thanks for the directions!
I set up all the boilerplate today and was just looking into (re)using type checker information and collecting across all modules. @DavyLandman and I will discuss tomorrow.

[toinehartman]

Feature milestones

Milestone 1 [boilerplate] (#389)

• Testing framework
• Support for renaming local variables

Milestone 2 [locals] (#389)

• Nested function names
• Formal parameters
• Pattern variables

Milestone 3 [globals] (#397)

• Global variables
• Functions (private)
• Functions (public)
• Aliases
• Overloads
• Extends
• Collection fields
• Data fields
• Type parameters
• Annotations
• Tags
• Function keyword parameters
• Constructor keyword parameters

Milestone 4 [modules] (#397)

• Module names

Milestone 5 [grammars]

• Symbols
• Productions
• Production fields

[urbanfly]

@DavyLandman when will this be available in a new release?

[DavyLandman]

hi @urbanfly I hope soon, but there are some bugs we're still ironing out for the typechecker.

Once those are squashed, our priority will be to make a full release.