chore: sync *.ps1 EOL fix from canonical#30
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. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Syncs the repository template’s PowerShell line-ending policy to ensure #!/usr/bin/env pwsh shebang-based execution works correctly on Linux/macOS by avoiding CRLF and UTF-8 BOM in *.ps1 files.
Changes:
- Update
.gitattributesto enforce LF for*.ps1and document the shebang/CRLF/BOM rationale. - Remove
end_of_line = crlfandcharset = utf-8-bomoverrides for*.ps1in.editorconfig, relying on global defaults.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
.gitattributes |
Switch *.ps1 to eol=lf and update inline documentation explaining shebang compatibility requirements. |
.editorconfig |
Drop *.ps1 CRLF/BOM overrides so PowerShell scripts inherit LF + UTF-8 (no BOM) from global settings. |
- .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.Changes
.gitattributes*.ps1 text eol=crlf*.ps1 text eol=lf.editorconfig [*.ps1]end_of_line = crlf,charset = utf-8-bom[*]defaults)What does NOT change
Files in the index were already LF. No file content rewrites.
Note about the protected-files guard
Touches
.editorconfig(protected). Maintainer override required.Test plan
git ls-files --eol scripts/*.ps1showsi/lf w/* attr/text eol=lf