Skip to content

Commit ba4f2da

Browse files
committed
Update readme with current unsupported scenarios
1 parent e92df78 commit ba4f2da

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
functionality needed to enable a consistent and robust PowerShell development
99
experience in almost any editor or integrated development environment (IDE).
1010

11-
## [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) clients using PowerShell Editor Services:
11+
## [Language Server Protocol](https://microsoft.github.io/language-server-protocol/) clients using PowerShell Editor Services
1212

1313
The functionality in PowerShell Editor Services is available in the following editor extensions:
1414

@@ -141,14 +141,15 @@ PowerShell is not a statically typed language. As such, the renaming of function
141141
There are several edge case scenarios which may exist where rename is difficult or impossible, or unable to be determined due to the dynamic scoping nature of PowerShell.
142142

143143
The focus of the rename support is on quick updates to variables or functions within a self-contained script file. It is not intended for module developers to find and rename a symbol across multiple files, which is very difficult to do as the relationships are primarily only computed at runtime and not possible to be statically analyzed.
144+
👍👍 [Implemented and Tested Rename Scenarios](https://github.com/PowerShell/PowerShellEditorServices/blob/main/test/PowerShellEditorServices.Test.Shared/Refactoring)
144145

145146
🤚🤚 Unsupported Scenarios
146147

147-
❌ Renaming can only be done within a single file. Renaming symbols across multiple files is not supported.
148-
Files containing dotsourcing are currently not supported.
149-
Functions or variables must have a corresponding definition within their scope to be renamed. If we cannot find the original definition of a variable or function, the rename will not be supported.
150-
151-
👍👍 [Implemented and Tested Rename Scenarios](https://github.com/PowerShell/PowerShellEditorServices/blob/main/test/PowerShellEditorServices.Test.Shared/Refactoring)
148+
❌ Renaming can only be done within a single file. Renaming symbols across multiple files is not supported, even if those are dotsourced from the source file.
149+
Functions or variables must have a corresponding definition within their scope or above to be renamed. If we cannot find the original definition of a variable or function, the rename will not be supported.
150+
Dynamic Parameters are not supported
151+
❌ Dynamically constructed splat parameters will not be renamed/updated (e.g. `$splat = @{};$splat.a = 5;Do-Thing @a`)
152+
❌ Scoped variables (e.g. $SCRIPT:test) are not currently supported
152153

153154
📄📄 Filing a Rename Issue
154155

0 commit comments

Comments
 (0)