PowerShell / PowerShell/PSScriptAnalyzer

UseBOMForUnicodeEncodedFile - Still necessary?

Open
#810 4 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Area - Rules Issue - Discussion
Dominant language
C#
Stars
2.2k
Forks
414
Avg merge
13h 1m
Merged PRs (30d)
2

Description

Hiyo!

I won't pretend to know anything about encoding, but noticed this RFC draft was accepted a while back. Is there a need for UseBOMForUnicodeEncodedFile, given the RFC, or even without the RFC?

To clarify - is there any benefit to this rule? What breaks if there is no BOM? We know for sure that things break in the xplat world when there is a BOM (i.e. this rule passes), which seems a bit off.

Cheers!

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the UseBOMForUnicodeEncodedFile rule and read RFC0020-DefaultFileEncoding.md. Investigate what the rule currently protects against and how BOM behavior differs across platforms. Done means the rule's necessity is resolved and the issue records whether it should remain, change, or be removed, with relevant tests or documentation updated accordingly.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp, powershell
Domain
tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.