Add New-EditorFile #622

TylerLeonhardt · 2018-02-06T18:07:05Z

Here's what you can do:

Open-EditorFile foo.txt -Force

This will create a new file called foo.txt if no file exists. It will throw an error if you don't add -force and foo.txt does not exist.

Also,

Get-Process | Open-EditorFile foo.txt -Force

This will create a new file called foo.txt with the contents of what came in through the pipeline. Another example:

irm https://raw.githubusercontent.com/PowerShell/PowerShell/master/tools/install-powershell.ps1 | psedit install-powershell.ps1 -Force

You can also do:

Get-Process | Open-EditorFile

This will open an Untitled file in your editor and put the contents in it.

This works in local and remote sessions.

Note, Get-Process has an issue in remote sessions when piping to a file. I originally thought it was my code but it was not:
PowerShell/PowerShell#6115

The vscode-powershell PR is here: PowerShell/vscode-powershell#1197

Resolves #414
Resolves #413

daviwil · 2018-02-06T20:36:11Z

module/PowerShellEditorServices/Commands/Public/CmdletInterface.ps1

+        $FilePaths,
+
+        [Parameter(ValueFromPipeline=$true)]
+        $NewValue,


Set-Content uses Value as the name for this parameter, maybe good to be consistent since the behavior is similar? Not really a big deal, though.

daviwil · 2018-02-06T20:36:24Z

module/PowerShellEditorServices/Commands/Public/CmdletInterface.ps1

+    end {
+        $FilePaths | ForEach-Object {
+            if (-not (Test-Path $_) -and $Force) {
+                $container > $_


Definitely would be interested in Keith's feedback about this vs Set-Content -Force

Yeah, in the context of file manipulation the Force parameter is usually associated with dealing with read only files.

I'm also a bit confused about the purpose of this command. When I see the name Open-EditorFile I don't associate that with setting an initial content (NewValue). Isn't there a New-EditorFile which would take an optional Value (as well as Force to overwrite existing files)?

I think this command is trying to do a bit too much. Seems like it should just open the specified file in the editor workspace. Folks can then use the $pseditor api to modify its contents.

If the function does change value, I think it makes more sense to change it via the $psEditor API (with $psEditor.GetEditorContext().CurrentFile.InsertText()) instead of directly.

@rkeithhill New-EditorFile does not exist which is why I bundled it with Open-EditorFile but I guess we can just have another function.

I think that would be cleaner and more PowerShelly. :-)

rkeithhill · 2018-02-06T22:15:15Z

module/PowerShellEditorServices/Commands/Public/CmdletInterface.ps1

+    param(
+        [Parameter(Mandatory=$true)]
+        [ValidateNotNullOrEmpty()]
+        $FilePaths,


This should be singular and in this case I think Path is sufficient and consistent with the other PowerShell file manipulation commands.

Also, I think it would be better to have this command accept pipeline input for the path instead of content. But that requires some changes to the parameter config - see the Examples\PathProcessingWildcards.ps1 for an example of how to do that.

With this change, I would be able to do:

gci *.psd1 -r | Open-EditorFile

That seems more useful to me than using the pipeline to overwrite (or create) files with new content.

Could do both:

function Open-EditorFile { [CmdletBinding(PositionalBinding=$false, DefaultParameterSetName='Path')] param( [Parameter(Mandatory, ParameterSetName='Path', ValueFromPipeline, ValueFromPipelineByPropertyName, Position=0)] [Parameter(Mandatory, ParameterSetName='Value', Position=0)] [ValidateNotNullOrEmpty()] [Alias('FullName')] [string] $Path, [Parameter(ParameterSetName='Value', ValueFromPipeline)] [Parameter(ParameterSetName='Path')] [ValidateNotNullOrEmpty()] [string] $Value ) begin { if ($MyInvocation.ExpectingInput) { $valueList = [System.Collections.Generic.List[string]]::new() } } process { if ($PSCmdlet.ParameterSetName -eq 'Value') { $valueList.Add($Value) return } $psEditor.Workspace.OpenFile($Path) if ($Value) { $psEditor.GetEditorContext().CurrentFile.InsertText($Value) } } end { if ($PSCmdlet.ParameterSetName -eq 'Path') { return } $psEditor.Workspace.OpenFile($Path) $psEditor.GetEditorContext().CurrentFile.InsertText($valueList -join [Environment]::NewLine) } }

Allows for gci *.ps1 | Open-EditorFile -Value $x and gc .\sourceFile.ps1 | Open-EditorFile destinationFile.ps1.

TylerLeonhardt · 2018-02-08T01:05:31Z

I tried SO hard to get C# to read in a psm1 as a string... but eventually gave up and put the whole module in a string instead...

The benefit of this approach is that we can add more functions to the module string and they will be automatically added to remote sessions.

SeeminglyScience · 2018-02-09T18:02:03Z

module/PowerShellEditorServices/Commands/Public/CmdletInterface.ps1

+            } else {
+                $PSCmdlet.WriteError( (
+                    New-Object -TypeName System.Management.Automation.ErrorRecord -ArgumentList @(
+                        [System.Exception]'File already exists.'


Can we model this error record after New-Item?

New-Object -TypeName System.Management.Automation.ErrorRecord -ArgumentList @( [System.IO.IOException]"The file '$fileName' already exists.", 'NewEditorFileIOError', [System.Management.Automation.ErrorCategory]::WriteError, $fileName)

SeeminglyScience · 2018-02-09T18:05:38Z

module/PowerShellEditorServices/Commands/Public/CmdletInterface.ps1

+        foreach ($fileName in $Path)
+        {
+            if (-not (Test-Path $fileName) -or $Force) {
+                $container > $fileName


I'd really like to see this edit the file through $psEditor instead of directly.

SeeminglyScience · 2018-02-09T20:52:18Z

src/PowerShellEditorServices/Session/RemoteFileManager.cs

+            $psedit = New-Module -ScriptBlock ([Scriptblock]::Create($PSEditModule)) -Name PSEdit
+            $psedit.ExportedFunctions.Keys | ForEach-Object {
+                Set-Item -Path function:\global:$_ -Value $asdf.ExportedFunctions[$_].Definition -Force
+            }


If we're going the module route, can we pipe this into Import-Module instead?

@SeeminglyScience I tried Import-Module initially but it did not work. None of the cmdlets would show up... Could I have been missing a particular flag? I tried -Force and -Scope.

@tylerl0706 try -Global. I thought you only needed that when importing from a different session state, but I guess it's scope based. TIL

SeeminglyScience · 2018-02-09T20:53:08Z

src/PowerShellEditorServices/Session/RemoteFileManager.cs

-            {
-                Remove-Item -Path 'function:\global:Open-EditorFile' -Force
+            Get-Command | Where-Object {$_.Source -eq 'PSEdit'} | ForEach-Object {
+                Remove-Item -Path function:\global:$($_.Name) -Force


Same as above, Get-Module PSEdit | Remove-Module would be preferable

TylerLeonhardt · 2018-02-13T06:25:44Z

Ok I've addressed all of @SeeminglyScience's feedback.

I've also added a small additional feature to this... You can now do:

Get-Process | Open-EditorFile

This will open an Untitled file in your editor and put the contents in it.

This works in local and remote sessions.

SeeminglyScience

The changes look fantastic, great job man! :)
^{_{Assuming the AppVeyor build gets it's act together of course -_-}}

TylerLeonhardt · 2018-02-13T15:55:14Z

@daviwil this PR is substansially different than when you signed off. Can you look again?

Also, @rkeithhill, I've addressed your feedback.

rkeithhill · 2018-02-13T16:32:49Z

module/PowerShellEditorServices/Commands/Public/CmdletInterface.ps1

+    param(
+        [Parameter(Mandatory=$true, ValueFromPipeline=$true)]
+        [ValidateNotNullOrEmpty()]
+        $Path


As long as this parameter supports this scenario Get-ChildItem *.ps1 -r -file | Open-EditorFile, I'm good.

So @rkeithhill ... as it turns out, this will proceed to open the file temporarily (with the italicized file name)... so what ends up happening is, it opens the file temporarily and then the next file opens and replaces the file temporarily.

I'm not sure how to durably open files - if that's possible. I'll have to dig around.

@daviwil any thoughts?

Ah, yes. That's why I double-click the editor window tab. That converts it from a temp (resuable) window to a permanent one. Not sure how you do that programmatically though.

Exactly. Maybe if @SeeminglyScience or @daviwil know? Otherwise, can I convince you to call this out of scope 😄

You can use the vscode.window.showTextDocument() overload that takes a TextDocumentShowOptions object. One of the fields of that object is preview?. That should allow you to create each window in a "non-preview" window.

https://code.visualstudio.com/docs/extensionAPI/vscode-api#_a-nametextdocumentshowoptionsaspan-classcodeitem-id239textdocumentshowoptionsspan

That would be my preference. Later we could update the openFile() method to take an optional "preview" Boolean parameter.

Later we could update the openFile() method to take an optional "preview" Boolean parameter.

What if I already have this working? Is it worth adding it now or saving it for when someone actually asks for that?

I'll just push and you can judge whether we should keep it in or not

I'd like to have that option, so yeah, if it's working - go for it.

@rkeithhill pushed that. Here's the vscode-powershell PR as well:
PowerShell/vscode-powershell#1197

TylerLeonhardt · 2018-02-14T19:43:47Z

Ah! This resolves this as well:
#413

TylerLeonhardt · 2018-02-15T01:28:54Z

oh... appveyor.

TylerLeonhardt · 2018-02-15T19:40:43Z

Can you guys give a thumbs up to this if you still approve? There have been some substantial (enough) changes that those approvals don't really stand anymore.

rkeithhill

LGTM

daviwil

Looks good, merge it

add new file capabilities to psedit

1a31c75

TylerLeonhardt requested review from daviwil, rkeithhill and SeeminglyScience February 6, 2018 18:07

daviwil approved these changes Feb 6, 2018

View reviewed changes

rkeithhill reviewed Feb 6, 2018

View reviewed changes

Add New-EditorFile and dynamically load functions in module

9cd7901

TylerLeonhardt changed the title ~~Add new file capabilities to psedit~~ Add New-EditorFile Feb 8, 2018

SeeminglyScience requested changes Feb 9, 2018

View reviewed changes

Support no path opening an Untitled file

ddf3bb0

SeeminglyScience approved these changes Feb 13, 2018

View reviewed changes

rkeithhill reviewed Feb 13, 2018

View reviewed changes

add preview to open file

484c6c5

TylerLeonhardt mentioned this pull request Feb 14, 2018

handle preview variable PowerShell/vscode-powershell#1197

Merged

rkeithhill approved these changes Feb 15, 2018

View reviewed changes

daviwil approved these changes Feb 20, 2018

View reviewed changes

TylerLeonhardt merged commit f534ae6 into PowerShell:master Feb 20, 2018

TylerLeonhardt deleted the psedit-new-files branch February 20, 2018 21:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add New-EditorFile #622

Add New-EditorFile #622

TylerLeonhardt commented Feb 6, 2018 •

edited

Loading

daviwil Feb 6, 2018

daviwil Feb 6, 2018

rkeithhill Feb 6, 2018

SeeminglyScience Feb 6, 2018

TylerLeonhardt Feb 7, 2018

rkeithhill Feb 7, 2018

rkeithhill Feb 6, 2018

SeeminglyScience Feb 6, 2018

TylerLeonhardt commented Feb 8, 2018

SeeminglyScience Feb 9, 2018

SeeminglyScience Feb 9, 2018

SeeminglyScience Feb 9, 2018

TylerLeonhardt Feb 9, 2018

SeeminglyScience Feb 9, 2018

SeeminglyScience Feb 9, 2018

TylerLeonhardt commented Feb 13, 2018

SeeminglyScience left a comment •

edited

Loading

TylerLeonhardt commented Feb 13, 2018

rkeithhill Feb 13, 2018

TylerLeonhardt Feb 13, 2018

rkeithhill Feb 13, 2018

TylerLeonhardt Feb 13, 2018

rkeithhill Feb 13, 2018 •

edited

Loading

rkeithhill Feb 14, 2018

TylerLeonhardt Feb 14, 2018

TylerLeonhardt Feb 14, 2018

rkeithhill Feb 14, 2018

TylerLeonhardt Feb 14, 2018

TylerLeonhardt commented Feb 14, 2018

TylerLeonhardt commented Feb 15, 2018

TylerLeonhardt commented Feb 15, 2018

rkeithhill left a comment

daviwil left a comment

Add New-EditorFile #622

Add New-EditorFile #622

Conversation

TylerLeonhardt commented Feb 6, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TylerLeonhardt commented Feb 8, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TylerLeonhardt commented Feb 13, 2018

SeeminglyScience left a comment • edited Loading

Choose a reason for hiding this comment

TylerLeonhardt commented Feb 13, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rkeithhill Feb 13, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TylerLeonhardt commented Feb 14, 2018

TylerLeonhardt commented Feb 15, 2018

TylerLeonhardt commented Feb 15, 2018

rkeithhill left a comment

Choose a reason for hiding this comment

daviwil left a comment

Choose a reason for hiding this comment

TylerLeonhardt commented Feb 6, 2018 •

edited

Loading

SeeminglyScience left a comment •

edited

Loading

rkeithhill Feb 13, 2018 •

edited

Loading