Add file-path support to Invoke-Formatter by Copilot · Pull Request #2230 · PowerShell/PSScriptAnalyzer

Copilot · 2026-10-22T21:59:31Z

Invoke-Formatter currently accepts script text only. Add a file-based parameter set that formats files in place while retaining their encoding, line endings, and indentation style.

File formatting: Add -Path; keep -ScriptDefinition and its existing parameter behavior.
File properties: Detect encoding and line endings, and infer tabs or spaces when no indentation kind is explicitly configured. Respect -WhatIf.
Example:
```
Invoke-Formatter -Path ./script.ps1
```

Fixes Add -Path parameter to Invoke-Formatter #775

Co-authored-by: bergmeister <9250262+bergmeister@users.noreply.github.com>

* Document formatter confirmation parameters Co-authored-by: bergmeister <9250262+bergmeister@users.noreply.github.com> * Handle pipeline binding help values in tests Co-authored-by: bergmeister <9250262+bergmeister@users.noreply.github.com> * Clarify -Confirm and -WhatIf parameter descriptions Updated descriptions for -Confirm and -WhatIf parameters to clarify their effects when using the Path and ScriptDefinition options. Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: bergmeister <9250262+bergmeister@users.noreply.github.com> Co-authored-by: Christoph Bergmeister <c.bergmeister@gmail.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot

🟡 Changes recommended

Encoding handling can alter or corrupt files, and indentation inference can incorrectly change their style.

3 open issues

What changed in this PR

Adds in-place file formatting to Invoke-Formatter for issue #775, while retaining the existing script-text parameter set.

Changes:

Adds -Path, file-property detection, indentation inference, and -WhatIf support.
Adds file-formatting tests and updates pipeline-input help checks.
Documents file formatting and confirmation behavior.

File	Description
Tests/Engine/ModuleHelp.Tests.ps1	Updates checks for pipeline-binding help metadata.
Tests/Engine/InvokeFormatter.tests.ps1	Tests file formatting, encoding, indentation, and `-WhatIf`.
Engine/Commands/InvokeFormatterCommand.cs	Implements path-based formatting and file-property handling.
docs/Cmdlets/Invoke-Formatter.md	Documents the new parameter set and usage.

_{Review effort: Balanced}

Co-authored-by: bergmeister <9250262+bergmeister@users.noreply.github.com>

Refactor encoding handling and indentation logic. Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Copilot

🟡 Changes recommended

BOM-less legacy-encoded scripts fail to format, leaving the encoding-preservation requirement unmet.

1 open issue

Support explicit or fallback encodings for BOM-less scripts · New

1 previously missed issue

In code that hasn't changed since last review

Correct help syntax and parameter set declarations

docs/Cmdlets/Invoke-Formatter.md:21

The help source does not represent the new mutually exclusive parameter sets correctly: both invocations share one unnamed syntax block, and -ScriptDefinition still declares Parameter Sets: (All) at line 145. This file feeds New-ExternalHelp in build.psm1:65, so these declarations also affect generated help. Give ScriptDefinition (Default) and Path separate ### headings and syntax blocks, following docs/Cmdlets/Invoke-ScriptAnalyzer.md:16–53, and change the ScriptDefinition parameter metadata to Parameter Sets: ScriptDefinition.

3 resolved since last review

_{Review effort: Balanced}

Co-authored-by: bergmeister <9250262+bergmeister@users.noreply.github.com>

Copilot

🟡 Changes recommended

CR-only files encounter a formatting failure, and the legacy-encoding regression is not portable across supported Windows PowerShell environments.

3 open issues

1 resolved since last review

Support explicit or fallback encodings for BOM-less scripts

_{Review effort: Balanced}

+            int spaceIndentedLines = 0;
+            string firstIndentationKind = "space";
+            bool foundIndentation = false;
+            string[] lines = scriptDefinition.Split('\n');


+            [System.IO.File]::ReadAllBytes($path)[0..1] | Should -Be @(255, 254)
+        }
+
+        It 'Best-effort formats BOM-less files using a legacy encoding' {


+            $scriptDefinition = '$name=''café'''
+            $expected = '$name = ''café'''


* Initial plan * Handle CR-only formatter line endings Co-authored-by: bergmeister <9250262+bergmeister@users.noreply.github.com> * Make legacy encoding fixture source-independent Co-authored-by: bergmeister <9250262+bergmeister@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: bergmeister <9250262+bergmeister@users.noreply.github.com>

Initial plan

82848f3

Copilot AI assigned Copilot and Christoph Bergmeister (bergmeister) Oct 22, 2026

Copilot started work on behalf of Christoph Bergmeister (bergmeister) October 22, 2026 21:59

View session

Copilot AI linked an issue Oct 22, 2026 that may be closed by this pull request

Add -Path parameter to Invoke-Formatter #775

Open

Add Path support to Invoke-Formatter

ab19dd5

Co-authored-by: bergmeister <9250262+bergmeister@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Add -Path parameter to Invoke-Formatter~~ Add file-path support to Invoke-Formatter Oct 22, 2026

Copilot finished work on behalf of Christoph Bergmeister (bergmeister) October 22, 2026 22:09

Copilot AI requested a review from Christoph Bergmeister (bergmeister) October 22, 2026 22:09

Christoph Bergmeister (bergmeister) added this pull request to stack #2233 October 22, 2026 23:15

Christoph Bergmeister (bergmeister) removed this pull request from stack #2233 October 22, 2026 23:18

Christoph Bergmeister (bergmeister) requested a balanced review from Copilot October 23, 2026 06:50

Copilot started reviewing on behalf of Christoph Bergmeister (bergmeister) October 23, 2026 06:50

View session

Copilot AI reviewed Oct 23, 2026

View reviewed changes

Comment thread Engine/Commands/InvokeFormatterCommand.cs Outdated

Comment thread Engine/Commands/InvokeFormatterCommand.cs Outdated

Comment thread Engine/Commands/InvokeFormatterCommand.cs Outdated

Copilot started work on behalf of Christoph Bergmeister (bergmeister) October 23, 2026 07:06

View session

Fix formatter indentation inference

deb58bc

Co-authored-by: bergmeister <9250262+bergmeister@users.noreply.github.com>

Copilot finished work on behalf of Christoph Bergmeister (bergmeister) October 23, 2026 07:18

Improve encoding reading and indentation inference

6dc79da

Refactor encoding handling and indentation logic. Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Christoph Bergmeister (bergmeister) requested a balanced review from Copilot October 23, 2026 07:39

Copilot started reviewing on behalf of Christoph Bergmeister (bergmeister) October 23, 2026 07:40

View session

Copilot AI reviewed Oct 23, 2026

View reviewed changes

Comment thread Engine/Commands/InvokeFormatterCommand.cs Outdated

Copilot started work on behalf of Christoph Bergmeister (bergmeister) October 23, 2026 07:48

View session

Support explicit encodings in file formatting

e113020

Co-authored-by: bergmeister <9250262+bergmeister@users.noreply.github.com>

Copilot finished work on behalf of Christoph Bergmeister (bergmeister) October 23, 2026 07:54

Copilot started work on behalf of Christoph Bergmeister (bergmeister) October 23, 2026 07:56

View session

Remove formatter encoding parameter

d0ba92d

Co-authored-by: bergmeister <9250262+bergmeister@users.noreply.github.com>

Copilot finished work on behalf of Christoph Bergmeister (bergmeister) October 23, 2026 08:01

Christoph Bergmeister (bergmeister) requested a balanced review from Copilot October 23, 2026 08:04

Copilot started reviewing on behalf of Christoph Bergmeister (bergmeister) October 23, 2026 08:04

View session

Copilot AI reviewed Oct 23, 2026

View reviewed changes

Christoph Bergmeister (bergmeister) added this pull request to stack #2235 October 23, 2026 10:25

Copilot AI mentioned this pull request Oct 23, 2026

Preserve CR-only line endings when formatting files #2234

Merged

Christoph Bergmeister (bergmeister) removed this pull request from stack #2235 October 23, 2026 17:45

Navigation Menu

Repository navigation

Add file-path support to Invoke-Formatter - #2230

Add file-path support to Invoke-Formatter#2230
Christoph Bergmeister (bergmeister) with Copilot wants to merge 8 commits into
mainfrom
copilot/add-path-parameter-to-invoke-formatter

Copilot AI commented Oct 22, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		$scriptDefinition = '$name=''café'''
		$expected = '$name = ''café'''

Conversation

Copilot AI commented Oct 22, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Oct 22, 2026 •

edited

Loading