Skip to content

chore: sync *.ps1 EOL fix from canonical#153

Merged
Chris-Wolfgang merged 2 commits into
mainfrom
chore/sync-ps1-eol-from-canonical
May 13, 2026
Merged

chore: sync *.ps1 EOL fix from canonical#153
Chris-Wolfgang merged 2 commits into
mainfrom
chore/sync-ps1-eol-from-canonical

Conversation

@Chris-Wolfgang

Copy link
Copy Markdown
Owner

Summary

Syncs the canonical *.ps1 EOL fix from repo-template#347 + #348. Removes the CRLF + UTF-8-BOM overrides for *.ps1 files in .gitattributes and .editorconfig.

Why

The #!/usr/bin/env pwsh shebang at the top of every script in scripts/ doesn't work as an executable on Linux/macOS when files are stored with CRLF + BOM:

  1. CRLF: kernel parses #!/usr/bin/env pwsh\r and tries to find an interpreter named pwsh\r — fails.
  2. BOM: bytes EF BB BF appear 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

File Before After
.gitattributes *.ps1 text eol=crlf *.ps1 text eol=lf
.editorconfig [*.ps1] end_of_line = crlf, charset = utf-8-bom (both removed; LF + utf-8 from [*] defaults)

Comments rewritten to explain the shebang rationale.

What does NOT change

  • Files in the index: already LF. The CRLF rule was aspirational policy that never matched reality. No file content rewrites in this PR.
  • Windows users: core.autocrlf=true (Git for Windows default) still gives CRLF in working tree on checkout. Only the index/wire format is LF.
  • Indent: still 4 spaces for *.ps1.

Note about the protected-files guard

This PR touches .gitattributes (in canonical the rule is in .editorconfig's domain too) and .editorconfig (protected). The Detect .NET Projects guard will fail it. Maintainer override required — same path as the canonical PRs.

Test plan

  • Maintainer override + merge
  • After merge, git ls-files --eol scripts/*.ps1 shows i/lf w/* attr/text eol=lf everywhere

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>
Copilot AI review requested due to automatic review settings May 10, 2026 00:20

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Aligns repository policy for PowerShell scripts with cross-platform execution requirements by removing CRLF/UTF-8-BOM overrides so #!/usr/bin/env pwsh shebang scripts work correctly on Linux/macOS.

Changes:

  • Update .gitattributes to store *.ps1 as LF in the index (instead of CRLF) and revise rationale comments.
  • Remove end_of_line = crlf and charset = utf-8-bom from .editorconfig’s [*.ps1] section, relying on global defaults (LF + UTF-8).

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
.gitattributes Switches *.ps1 to eol=lf and updates commentary to explain shebang constraints.
.editorconfig Drops PS1 CRLF/BOM overrides so PS1 inherits LF + UTF-8 from [*].

Comment thread .editorconfig Outdated
Comment thread .gitattributes Outdated
- .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.
- .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.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants