FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Provide more guidance for file encoding by sdwheeler · Pull Request #285 · MicrosoftDocs/PowerShell-Docs-Modules · GitHub

/ PowerShell-Docs-Modules Public

Provide more guidance for file encoding #285

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

Merged
Mike F. Robbins (mikefrobbins) merged 2 commits into from
Jan 7, 2025
Conversation 3 Commits 2 Checks 0 Files changed
Merged

Provide more guidance for file encoding #285

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c3d279a
Provide more guidance for file encoding
sdwheeler Jan 7, 2025
3ccd272
Update HelpFile encoding rule
sdwheeler Jan 7, 2025
File filter

Filter by extension

Filter by extension .md  (2) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
28 changes: 26 additions & 2 deletions reference/docs-conceptual/PSScriptAnalyzer/Rules/UseBOMForUnicodeEncodedFile.md
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: Use BOM encoding for non-ASCII files
ms.date: 06/28/2023
ms.date: 01/07/2025
ms.topic: reference
title: UseBOMForUnicodeEncodedFile
---
Expand All @@ -13,6 +13,30 @@ title: UseBOMForUnicodeEncodedFile
For a file encoded with a format other than ASCII, ensure Byte Order Mark (BOM) is present to ensure
that any application consuming this file can interpret it correctly.

You can use this rule to test any arbitrary text file, but the intent is to ensure that PowerShell
scripts are saved with a BOM when using a Unicode encoding.

## How

Ensure that the file is encoded with BOM present.
For PowerShell commands that write to files, ensure that you set the encoding parameter to a value
that produces a BOM. In PowerShell 7 and higher, the following values of the **Encoding** parameter
produce a BOM:

- `bigendianunicode`
- `bigendianutf32`
- `oem`
- `unicode`
- `utf32`
- `utf8BOM`

When you create a script file using a text editor, ensure that the editor is configured to save the
file with a BOM. Consult the documentation for your text editor for instructions on how to save
files with a BOM.

## Further reading

For more information, see the following articles:

- [about_Character_Encoding](/powershell/module/microsoft.powershell.core/about/about_character_encoding)
- [Set-Content](xref:Microsoft.PowerShell.Management.Set-Content)
- [Understanding file encoding in VS Code and PowerShell](/powershell/scripting/dev-cross-plat/vscode/understanding-file-encoding)
24 changes: 22 additions & 2 deletions reference/docs-conceptual/PSScriptAnalyzer/Rules/UseUTF8EncodingForHelpFile.md
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: Use UTF8 Encoding For Help File
ms.date: 06/28/2023
ms.date: 01/07/2025
ms.topic: reference
title: UseUTF8EncodingForHelpFile
---
Expand All @@ -10,4 +10,24 @@ title: UseUTF8EncodingForHelpFile

## Description

Check if help file uses UTF-8 encoding.
Check that an `about_` help file uses UTF-8 encoding. The filename must start with `about_` and end
with `.help.txt`. The rule uses the **CurrentEncoding** property of the **StreamReader** class to
determine the encoding of the file.

## How

For PowerShell commands that write to files, ensure that you set the encoding parameter to `utf8`,
`utf8BOM`, or `utf8NoBOM`.

When you create a help file using a text editor, ensure that the editor is configured to save the
file in a UTF8 format. Consult the documentation for your text editor for instructions on how to
save files with a specific encoding.

## Further reading

For more information, see the following articles:

- [System.IO.StreamReader](xref:System.IO.StreamReader.CurrentEncoding%2A)
- [about_Character_Encoding](/powershell/module/microsoft.powershell.core/about/about_character_encoding)
- [Set-Content](xref:Microsoft.PowerShell.Management.Set-Content)
- [Understanding file encoding in VS Code and PowerShell](/powershell/scripting/dev-cross-plat/vscode/understanding-file-encoding)
Back | FazBrowse Home | New Git URL