Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Edit-File command #19

Open
rkeithhill opened this issue Nov 25, 2020 · 11 comments · May be fixed by #21
Open

Add Edit-File command #19

rkeithhill opened this issue Nov 25, 2020 · 11 comments · May be fixed by #21
Milestone
1.0 Consider

Comments

@rkeithhill
Copy link

I would really love to see this command added. PS has been missing an easy way to modify files since v1. This comes in so handy for build systems. Our builds, first thing, edit a number of files to modify version numbers using this command e.g.:

# Update C# interop assembly version
Edit-FileContent -Path (Join-Path $rootPath 'src/Adapters/Acme.Wiley.Coyote.Api/Acme.Wiley.Coyote.Api.csproj') `
    -Pattern '(?<=\<Version\>)(.*?)(?=\</Version\>)' `
    -Replacement "${wileyVersion}.0"
Edit-FileContent -Path (Join-Path $rootPath 'src/Adapters/Acme.Wiley.Coyote.Api/Acme.Wiley.Coyote.Api.csproj') `
    -Pattern '(?<=\<InformationalVersion\>)(.*?)(?=\</InformationalVersion\>)' `
    -Replacement "${wileyVersion}${suffix}"

# WileyClient Conan C++ Support
Edit-FileContent -Path (Join-Path $rootPath 'src/WileyClient/conanfile.py') `
    -Pattern '(?<= version\s*=\s*'')(.*?)(?='')' `
    -Replacement "${wileyVersion}${suffix}"

# WileyManagement Conan C++ Support
Edit-FileContent -Path (Join-Path $rootPath 'src/WileyManagement/conanfile.py') `
    -Pattern '(?<= version\s*=\s*'')(.*?)(?='')' `
    -Replacement "${wileyVersion}${suffix}"
Edit-FileContent -Path (Join-Path $rootPath 'src/WileyManagement/conanfile.py') `
    -Pattern '(?<=WileyClient/)(.*?)(?=@Acme)' `
    -Replacement "${wileyVersion}${suffix}"

# NuGet C# Support
Edit-FileContent -Path (Join-Path $rootPath 'build/NuGet/WileyClientPkg/Acme.Wiley.Coyote.Api.nuspec') `
    -Pattern '(?<=\<version\>)(.*?)(?=\</version\>)' `
    -Replacement "${wileyVersion}${suffix}"
Edit-FileContent -Path (Join-Path $rootPath 'build/NuGet/WileyClientPkg/Acme.Wiley.Coyote.Api.nuspec') `
    -Pattern '(?<=id="runtime\.native\.Acme\.Wiley\.Coyote\.Api"\s+version=")(.*?)(?=")' `
    -Replacement "${wileyVersion}${suffix}"
Edit-FileContent -Path (Join-Path $rootPath 'build/NuGet/runtime.native.WileyClientPkg/runtime.native.Acme.Wiley.Coyote.Api.nuspec') `
    -Pattern '(?<=\<version\>)(.*?)(?=\</version\>)' `
    -Replacement "${wileyVersion}${suffix}"

# API Help Docs
$regexForHelpDocs = if ($Final) { '(?<== ")(\d)(.\d)*-?.* PRELIMINARY(?=")' } else { '(?<== ")(\d)(.\d)*-?.*(?= PRELIMINARY")' }
Edit-FileContent -Path (Join-Path $rootPath 'doc/CppReference/wiley-cpp-doxyfile') `
    -Pattern $regexForHelpDocs `
    -Replacement "${wileyVersion}${suffix}"

And here's the implementation - feel free to use as much (or little) as you want. https://github.com/Pscx/Pscx/blob/master/Src/Pscx/Commands/IO/EditFileCommand.cs
@rkeithhill
Copy link
Author

OK, I'm taking a swag at importing the PSCX EditFileCommand.cs. Hopefully will have a PR soon-ish.

@SteveL-MSFT
Copy link
Member

Should it just be Edit-Content to match the other *-Content cmdlets? It could accept text via pipeline and also allow editing?

@AdilHindistan
Copy link

I needed this once or twice and used something like (gc {file}) -replace {pattern}, {replacement} | out-file ...to do that. This would be a nice shortcut.

@rkeithhill
Copy link
Author

rkeithhill commented Nov 25, 2020 •
edited

I'm fine with Edit-Content. The main thing we were trying to avoid is this approach:

Get-Content foo.csproj | % { $_ -replace $pattern,$replacement } | Set-Content foo.csproj

Where you have the file locking problem (trying to write to file while reading it) as well as this doesn't preserve the file's original encoding which should be a goal of this command. Anway, the above pattern is common enough to warrant a simpler form:

Edit-Content foo.csproj $pattern $replacement

@rkeithhill
Copy link
Author

rkeithhill commented Nov 25, 2020 •
edited

Hmm, the PSCX implementation has an elaborate way of supporting Path/LiteralPath that won't port over. @SteveL-MSFT is there a canonical sample of Path/LiteralPath C# code I can use?

@SteveL-MSFT
Copy link
Member

@rkeithhill check https://github.com/PowerShell/PowerShell/blob/15e4e8a6af2f120bbd1eef8607131d878677c0ad/src/Microsoft.PowerShell.Commands.Management/commands/management/ContentCommandBase.cs#L35-L44

@rkeithhill
Copy link
Author

@SteveL-MSFT Do you think this cmdlet should derive from ContentCommandBase? If not, I can't quite use that code as-is since it calls down into a base class to suppress wildcard expansion. And if yes, won't that require -Include and -Filter parameters which wouldn't make so much sense for this cmdlet.

To be honest, the implementation of the functionality isn't too bad but dealing with Path/LiteralPath parameters has been such a PITA that @oising added easier handling for these parameters in PSCX in the form of PscxPathInfo (see https://github.com/Pscx/Pscx/blob/master/Src/Pscx.Core/Commands/PscxPathCommandBase.cs)

@SteveL-MSFT
Copy link
Member

@rkeithhill sorry, pointed you to the wrong thing. Perhaps do something similar to https://github.com/PowerShell/PowerShellGet/blob/f1ddcb3bc602c61f9b98f79b1ab02b00331da8f5/src/code/PublishPSResource.cs#L95

@rkeithhill
Copy link
Author

rkeithhill commented Dec 5, 2020 •
edited

@SteveL-MSFT Thanks. That got me past the Path/LiteralPath parameter issue. I have something that compiles and runs. However, I had to copy over some crufty PSCX code for the Encoding parameter (to do string conversion, checks, etc). I'm hopeful I can find some more modern and hopefully SMA built-in support. Do you have any pointers for that? I could submit a PR now but ... I'd rather have better Encoding parameter support implemented first.

FYI the command's default behavior is to try to preserve the file's original encoding so the -Encoding parameter isn't normally needed unless you also want to change the file's encoding.

@rkeithhill
Copy link
Author

rkeithhill commented Dec 7, 2020 •
edited

@SteveL-MSFT OK found some code in Out-File.cs but ... the Encoding parameter support required me to copy a number of internal classes. Sigh... In order to support "easier to write", "more consistent & correcrt" parameter handling in C# cmdlets (and even script cmdlets), more of these "internal" classes need to be made public.

FWIW I'm not a big fan of how some of this is implemented e.g. deriving from ContentCommandBase.cs to get Path/LiteralPath handling. We did something similar in PSCX and when it worked it was nice but there were a number of cases where it didn't work. So, the answer probably isn't to just make existing internal classes public. It would be better to provide "parameter implementations" that folks can use & configure via attributes (or interfaces). Two very good parameters to start with would be Path and LiteralPath.

Anyway, I should have an initial WIP PR out in a few days.

@rkeithhill rkeithhill linked a pull request Dec 9, 2020 that will close this issue
Open
@SteveL-MSFT SteveL-MSFT added this to the 1.0 Consider milestone Jul 25, 2023
@SteveL-MSFT
Copy link
Member

We may choose to include Jim's version and call it Edit-TextFile as there have been asks to edit other file types.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
1.0 Consider
Development

Successfully merging a pull request may close this issue.

WIP: initial implementation of Edit-Content command rkeithhill/TextUtility
3 participants
@AdilHindistan @rkeithhill @SteveL-MSFT