Skip to content

Added Get-FileEncoding cmdlet - #20586

Closed
Armaan Mcleod (ArmaanMcleod) wants to merge 8 commits into
PowerShell:masterfrom
ArmaanMcleod:get-file-encoding-cmdlet
Closed

Added Get-FileEncoding cmdlet#20586
Armaan Mcleod (ArmaanMcleod) wants to merge 8 commits into
PowerShell:masterfrom
ArmaanMcleod:get-file-encoding-cmdlet

Conversation

@ArmaanMcleod

@ArmaanMcleod Armaan Mcleod (ArmaanMcleod) commented Oct 27, 2023

Copy link
Copy Markdown
Contributor

PR Summary

Fixes #2290.

Added Get-FileEncoding cmdlet to detect encoding from file using System.IO.StreamReader.CurrentEncoding.

Also moved the GetPathEncoding method to PathUtils so it can be shared easily between cmdlets.

PR Context

Parameter Sets

Get-FileEncoding [-Path] <string> [<CommonParameters>]

Get-FileEncoding [-LiteralPath] <string> [<CommonParameters>]

Usage

> Get-FileEncoding -Path .\.markdownlint.json

Preamble          :
BodyName          : utf-8
EncodingName      : Unicode (UTF-8)
HeaderName        : utf-8
WebName           : utf-8
WindowsCodePage   : 1200
IsBrowserDisplay  : True
IsBrowserSave     : True
IsMailNewsDisplay : True
IsMailNewsSave    : True
IsSingleByte      : False
EncoderFallback   : System.Text.EncoderReplacementFallback
DecoderFallback   : System.Text.DecoderReplacementFallback
IsReadOnly        : True
CodePage          : 65001

PR Checklist

@ThomasNieto

Thomas Nieto (ThomasNieto) commented Oct 27, 2023

Copy link
Copy Markdown
Contributor

The issue predates the TextUtility module. I feel this cmdlet should be in that module so earlier PowerShell versions can make use of it.

iSazonov
Ilya (iSazonov) approved these changes Oct 27, 2023
View reviewed changes
Comment thread src/Microsoft.PowerShell.Commands.Utility/commands/utility/GetFileEncodingCommand.cs
/// <summary>
/// This class implements the Get-FileEncoding command.
/// </summary>
[Cmdlet(VerbsCommon.Get, "FileEncoding", DefaultParameterSetName = PathParameterSet, HelpUri = "https://go.microsoft.com/fwlink/?LinkID=1234567")]

@iSazonov Ilya (iSazonov) Oct 27, 2023

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need new link.

@ArmaanMcleod Armaan Mcleod (ArmaanMcleod) Oct 27, 2023

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah put this one as a placeholder. I will also fill out documentation issue.

@iSazonov Ilya (iSazonov) added WG-Cmdlets general cmdlet issues Review - Committee The PR/Issue needs a review from the PowerShell Committee CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log labels Oct 27, 2023
@pull-request-quantifier-deprecated

pull-request-quantifier-deprecated Bot commented Oct 27, 2023

Copy link
Copy Markdown

This PR has 76 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

Quantification details 

Label      : Small
Size       : +69 -7
Percentile : 30.4%

Total files changed: 7

Change summary by file extension:
.cs : +35 -5
.psd1 : +2 -2
.ps1 : +32 -0

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detected.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.

Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

@SteveL-MSFT

Steve Lee (SteveL-MSFT) commented Nov 1, 2023 •
edited by unfurl-links Bot
Loading

Copy link
Copy Markdown
Member

@PowerShell/wg-powershell-cmdlets discussed this and we agreed that this is a useful cmdlet, however, it should be part of the https://github.com/powershell/textutility module and not part of PS7 itself.

GitHub
Microsoft.PowerShell.TextUtility module. Contribute to PowerShell/TextUtility development by creating an account on GitHub.

@SteveL-MSFT Steve Lee (SteveL-MSFT) added WG-Reviewed A Working Group has reviewed this and made a recommendation and removed Review - Committee The PR/Issue needs a review from the PowerShell Committee labels Nov 1, 2023
@ArmaanMcleod

Armaan Mcleod (ArmaanMcleod) commented Nov 4, 2023

Copy link
Copy Markdown
Contributor Author

Thanks Steve Lee (@SteveL-MSFT) & Thomas Nieto (@ThomasNieto) for the feedback. I'll make a PR in the TextUtility repo and close this PR.

@ArmaanMcleod Armaan Mcleod (ArmaanMcleod) mentioned this pull request Nov 4, 2023
Open
@microsoft-github-policy-service microsoft-github-policy-service Bot added the Review - Needed The PR is being reviewed label Nov 11, 2023
@microsoft-github-policy-service microsoft-github-policy-service Bot removed the Review - Needed The PR is being reviewed label Nov 11, 2023
@microsoft-github-policy-service

microsoft-github-policy-service Bot commented Nov 11, 2023 •
edited by unfurl-links Bot
Loading

Copy link
Copy Markdown
Contributor

📣 Hey Armaan Mcleod (@ArmaanMcleod), how did we do? We would love to hear your feedback with the link below! 🗣️

🔗 https://forms.office.com/r/P926k48jRJ

@ArmaanMcleod
Armaan Mcleod (ArmaanMcleod) deleted the get-file-encoding-cmdlet branch November 11, 2023 20:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@iSazonov Ilya (iSazonov) iSazonov approved these changes

Assignees

No one assigned

Labels

CL-General Indicates that a PR should be marked as a general cmdlet change in the Change Log Small WG-Cmdlets general cmdlet issues WG-Reviewed A Working Group has reviewed this and made a recommendation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add Get-FileEncoding cmdlet or function.

4 participants

@ArmaanMcleod @ThomasNieto @SteveL-MSFT @iSazonov