chore: sync *.ps1 EOL fix from canonical#91
Merged
Conversation
Removes the CRLF + UTF-8-BOM overrides for *.ps1 files in .gitattributes and .editorconfig. Required for the '#!/usr/bin/env pwsh' shebang at the top of every script in scripts/ to work as an executable on Linux/macOS. No file content rewrites — index has been LF the whole time. Only attr declarations align with reality now. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Syncs repository formatting policy for PowerShell scripts to use LF (and avoid UTF-8 BOM) so #!/usr/bin/env pwsh scripts can be executed reliably on Linux/macOS, aligning this repo with the canonical template changes.
Changes:
- Update
.gitattributesto normalize*.ps1files toeol=lfand refresh the rationale comment. - Remove
*.ps1-specificend_of_lineandcharsetoverrides from.editorconfig, relying on global defaults.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| .gitattributes | Switches *.ps1 EOL attribute from CRLF to LF and updates explanatory comments. |
| .editorconfig | Removes *.ps1 CRLF + UTF-8 BOM overrides, relying on global [*] defaults. |
Address both Copilot findings on this PR by pulling the latest .gitattributes and .editorconfig from repo-template (canonical) and adding the shebang to scripts/Setup-Labels.ps1: - .gitattributes: replace the comment that incorrectly implied core.autocrlf could still give Windows users CRLF when *.ps1 is configured with `text eol=lf`. The canonical comment now clearly states `eol=lf` forces LF in BOTH the index AND the working tree (overriding core.autocrlf). Verified against repo-template main. - .editorconfig: drop the redundant [*.ps1] section. The global [*] section already provides end_of_line = lf, charset = utf-8 (no BOM), and indent_size = 4; the per-extension override was a no-op. - scripts/Setup-Labels.ps1: add `#!/usr/bin/env pwsh` shebang so the comment in .gitattributes about "every script in scripts/" is factually accurate, and so the script is executable on Linux/macOS. - Renormalize Setup-Labels.ps1 to LF in the index (it was committed with CRLF before *.ps1 was set to `eol=lf`).
- .editorconfig: drop the [*.ps1] section entirely. Its only rule (indent_size = 4) was a no-op since the global [*] section already sets indent_size = 4. The shebang-rationale comment now sits as a top-level note explaining why no override is needed, and is honest that the shebang is only present 'where present' rather than in 'every script in scripts/'. - .gitattributes: tighten the *.ps1 comment so it doesn't imply that `eol=lf` prevents a BOM. Git attributes can only normalize line endings; BOM avoidance is enforced via .editorconfig's charset setting. Also clarify that `* text=auto eol=lf` (top of file) takes precedence over core.autocrlf, so the previous claim about Windows users getting CRLF in their working tree was inaccurate. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Syncs the canonical
*.ps1EOL fix from repo-template#347 + #348. Removes the CRLF + UTF-8-BOM overrides for*.ps1files in.gitattributesand.editorconfig.Why
The
#!/usr/bin/env pwshshebang at the top of every script inscripts/doesn't work as an executable on Linux/macOS when files are stored with CRLF + BOM:#!/usr/bin/env pwsh\rand tries to find an interpreter namedpwsh\r— fails.EF BB BFappear before#!, so the kernel doesn't recognize the file as a shebang script at all.The original "PowerShell uses CRLF for Windows compatibility" rationale predates PowerShell 7+ (cross-platform). The PowerShell team's own canonical repos (
PowerShell/PowerShell,PSScriptAnalyzer) all use LF + no BOM.Changes
.gitattributes*.ps1 text eol=crlf*.ps1 text eol=lf.editorconfig [*.ps1]end_of_line = crlf,charset = utf-8-bom[*]defaults)Comments rewritten to explain the shebang rationale.
What does NOT change
core.autocrlf=true(Git for Windows default) still gives CRLF in working tree on checkout. Only the index/wire format is LF.*.ps1.Note about the protected-files guard
This PR touches
.gitattributes(in canonical the rule is in.editorconfig's domain too) and.editorconfig(protected). TheDetect .NET Projectsguard will fail it. Maintainer override required — same path as the canonical PRs.Test plan
git ls-files --eol scripts/*.ps1showsi/lf w/* attr/text eol=lfeverywhere