This is a script to verify file encodings. It will ensure that none text files in the repository (identified as text by Git) have \r\n line endings or UTF-8 BOM attached to them.
Install the module from the PowerShell Gallery:
$ Install-Module VerifyEncoding -Repository PSGallery -Scope CurrentUserThen use as a PowerShell function:
$ Import-Module VerifyEncoding
$ Test-Encoding [[-SourceRoot] <SourceRoot>] [-Autofix] [[-ExcludeExtensions] <String[]>]
Copy the VerifyEncoding/Test-Encoding.ps1 script to your repo (or get from the Releases section),
then use from any shell as
$ pwsh Test-Encoding.ps1 [[-SourceRoot] <SourceRoot>] [-Autofix] [[-ExcludeExtensions] <String[]>]Either clone the sources or download the latest module archive from the Releases section, and then run the following PowerShell commands:
$ Import-Module ./VerifyEncoding/VerifyEncoding.psd1
$ Test-Encoding [[-SourceRoot] <SourceRoot>] [-Autofix] [[-ExcludeExtensions] <String[]>]SourceRootis the directory where the script will look for the files. By default (if nothing's passed), the script will try auto-detecting the nearest Git root.-Autofixwill apply fixes to all the problematic files.-ExcludeExtensionsallows passing an array of file extensions (case-insensitive) that will be ignored during the check. The default list is@('.dotsettings')
Add the following block to your CI script (here I'll use GitHub Actions, but it's possible to adapt to any other CI provider):
jobs:
encoding:
runs-on: ubuntu-latest # or any other runner that has PowerShell installed
steps:
# […]
- name: Verify encoding
shell: pwsh
run: Install-Module VerifyEncoding -Repository PSGallery -RequiredVersion 2.2.0 -Force && Test-Encoding <parameters go here>This command will generate a non-zero exit code in case there's a validation error and list all the files with issues.
If you use Renovate to automatically manage dependencies on CI,
you may set it up to update VerifyEncoding as well.
If you have the previously recommended Install-Module command called in your CI setup script,
then add the following into your renovate.json, and it will also update VerifyEncoding from the PowerShell Gallery:
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": "...",
"customManagers": [
{
"customType": "regex",
"fileMatch": [
"^\\.github/workflows/.+\\.yml$"
],
"matchStrings": [
"Install-Module (?<depName>\\S+?) -RequiredVersion (?<currentValue>\\S+)"
],
"datasourceTemplate": "nuget",
"registryUrlTemplate": "https://www.powershellgallery.com/api/v2/"
}
]
}The project is distributed under the terms of the MIT license.
The license indication in the project's sources is compliant with the REUSE specification v3.3.