PowerShell / PowerShell/PSScriptAnalyzer
Missing line number in rule PSUseBOMForUnicodeEncodedFile
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 2.2k
- Forks
- 414
- Avg merge
- 13h 1m
- Merged PRs (30d)
- 2
Description
Line numbers are missing for the Rule "Missing Line Number for PSUseBOMForUnicodeEncodedFile"
Steps to reproduce
Introduce a file test.ps1 with the following content:
Get–ChildItem
Run the PSScriptAnalyzer in the directory where the file remains.
Be aware of the dash:
The character U+2013 "–" could be confused with the character U+002d "-", which is more common in source code.
Expected behavior
Invoke-ScriptAnalyzer -Recurse -Path .
RuleName Severity ScriptName Line Message
-------- -------- ---------- ---- -------
PSUseBOMForUnicodeEncodedFile Warning test.ps1 1 Missing BOM encoding for non-ASCII encoded file 'test.ps1'
Actual behavior
Invoke-ScriptAnalyzer -Recurse -Path .
RuleName Severity ScriptName Line Message
-------- -------- ---------- ---- -------
PSUseBOMForUnicodeEncodedFile Warning test.ps1 Missing BOM encoding for non-ASCII encoded file 'test.ps1'
If an unexpected error was thrown then please report the full error details using e.g. $error[0] | Select-Object *
Environment data
> $PSVersionTable
Name Value
---- -----
PSVersion 7.2.5
PSEdition Core
GitCommitId 7.2.5
OS Microsoft Windows 10.0.19044
Platform Win32NT
PSCompatibleVersions {1.0, 2.0, 3.0, 4.0…}
PSRemotingProtocolVersion 2.3
SerializationVersion 1.1.0.1
WSManStackVersion 3.0
> (Get-Module -ListAvailable PSScriptAnalyzer).Version | ForEach-Object { $_.ToString() }
1.21.0
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the issue with the provided test.ps1 content and Invoke-ScriptAnalyzer command, then search the repository for PSUseBOMForUnicodeEncodedFile and the diagnostic creation. Done means the warning reports line 1 for test.ps1, with a regression test covering the non-ASCII file case.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, powershell
- Domain
- testing-qa, tooling
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100