De-BOM the 17 legacy .cs files #269 touched (charset=utf-8 violation) #310

Closed
opened 2026-07-12 20:07:54 +02:00 by timothy · 2 comments
Owner

Backlog / cleanup. Surfaced while landing the #303 process-followups PR (#309).

What

.editorconfig mandates charset=utf-8 (no BOM), but 2530 of 3934 tracked .cs files carry a legacy UTF-8 BOM (efbbbf) inherited from upstream ErsatzTV. Per our fix-formatting-as-you-touch convention (being documented in contributing.md §7 via #309-followup), a file edited for other work should be normalized (incl. BOM strip) in that same PR.

#269 edited these 17 files but left the BOM in place (it presumably --no-verify'd past the local pre-commit dotnet format hook, which does flag the BOM — and CI never checks charset, so nothing else caught it):

ErsatzTV.Application/MediaCollections/Commands/AddArtistToCollectionHandler.cs
ErsatzTV.Application/MediaCollections/Commands/AddEpisodeToCollectionHandler.cs
ErsatzTV.Application/MediaCollections/Commands/AddImageToCollectionHandler.cs
ErsatzTV.Application/MediaCollections/Commands/AddItemsToCollectionHandler.cs
ErsatzTV.Application/MediaCollections/Commands/AddMediaItemToCollectionHandler.cs
ErsatzTV.Application/MediaCollections/Commands/AddMovieToCollectionHandler.cs
ErsatzTV.Application/MediaCollections/Commands/AddMusicVideoToCollectionHandler.cs
ErsatzTV.Application/MediaCollections/Commands/AddOtherVideoToCollectionHandler.cs
ErsatzTV.Application/MediaCollections/Commands/AddSeasonToCollectionHandler.cs
ErsatzTV.Application/MediaCollections/Commands/AddShowToCollectionHandler.cs
ErsatzTV.Application/MediaCollections/Commands/AddSongToCollectionHandler.cs
ErsatzTV.Application/MediaCollections/Commands/RemoveItemsFromCollectionHandler.cs
ErsatzTV.Application/MediaCollections/Commands/UpdateCollectionHandler.cs
ErsatzTV.Application/Playouts/Commands/UpdateExternalJsonPlayoutHandler.cs
ErsatzTV.Application/Playouts/Commands/UpdatePlayoutHandler.cs
ErsatzTV.Application/Playouts/Commands/UpdateScriptedPlayoutHandler.cs
ErsatzTV.Application/Playouts/Commands/UpdateSequentialPlayoutHandler.cs

Fix

Strip the BOM from these 17 files (e.g. sed -i '1s/^\xEF\xBB\xBF//' <file> or dotnet format ErsatzTV.sln --include <files>), verify with dotnet format ErsatzTV.sln --verify-no-changes --include <files>, one small PR. No behavior change.

Triage

Backlog (cleanup, non-gating). Distinct from the systemic BOM question (whether to ever mass-normalize all 2530) and from the enforcement work (PR-scoped charset CI + rebase hook) tracked separately.

**Backlog / cleanup.** Surfaced while landing the #303 process-followups PR (#309). ## What `.editorconfig` mandates `charset=utf-8` (no BOM), but **2530 of 3934 tracked `.cs` files carry a legacy UTF-8 BOM** (`efbbbf`) inherited from upstream ErsatzTV. Per our *fix-formatting-as-you-touch* convention (being documented in contributing.md §7 via #309-followup), a file edited for other work should be normalized (incl. BOM strip) in that same PR. #269 edited these **17** files but left the BOM in place (it presumably `--no-verify`'d past the local pre-commit `dotnet format` hook, which does flag the BOM — and CI never checks charset, so nothing else caught it): ``` ErsatzTV.Application/MediaCollections/Commands/AddArtistToCollectionHandler.cs ErsatzTV.Application/MediaCollections/Commands/AddEpisodeToCollectionHandler.cs ErsatzTV.Application/MediaCollections/Commands/AddImageToCollectionHandler.cs ErsatzTV.Application/MediaCollections/Commands/AddItemsToCollectionHandler.cs ErsatzTV.Application/MediaCollections/Commands/AddMediaItemToCollectionHandler.cs ErsatzTV.Application/MediaCollections/Commands/AddMovieToCollectionHandler.cs ErsatzTV.Application/MediaCollections/Commands/AddMusicVideoToCollectionHandler.cs ErsatzTV.Application/MediaCollections/Commands/AddOtherVideoToCollectionHandler.cs ErsatzTV.Application/MediaCollections/Commands/AddSeasonToCollectionHandler.cs ErsatzTV.Application/MediaCollections/Commands/AddShowToCollectionHandler.cs ErsatzTV.Application/MediaCollections/Commands/AddSongToCollectionHandler.cs ErsatzTV.Application/MediaCollections/Commands/RemoveItemsFromCollectionHandler.cs ErsatzTV.Application/MediaCollections/Commands/UpdateCollectionHandler.cs ErsatzTV.Application/Playouts/Commands/UpdateExternalJsonPlayoutHandler.cs ErsatzTV.Application/Playouts/Commands/UpdatePlayoutHandler.cs ErsatzTV.Application/Playouts/Commands/UpdateScriptedPlayoutHandler.cs ErsatzTV.Application/Playouts/Commands/UpdateSequentialPlayoutHandler.cs ``` ## Fix Strip the BOM from these 17 files (e.g. `sed -i '1s/^\xEF\xBB\xBF//' <file>` or `dotnet format ErsatzTV.sln --include <files>`), verify with `dotnet format ErsatzTV.sln --verify-no-changes --include <files>`, one small PR. No behavior change. ## Triage Backlog (cleanup, non-gating). Distinct from the *systemic* BOM question (whether to ever mass-normalize all 2530) and from the enforcement work (PR-scoped charset CI + rebase hook) tracked separately.
timothy added the ci-cdpriority: low labels 2026-07-12 20:11:21 +02:00
timothy added the in-progress label 2026-07-18 16:30:45 +02:00
Author
Owner

🤖 Claiming as part of a batched small-issue sweep this session (parallel worktrees, one PR per item). Will post a close comment per the Task Completion Protocol when its PR merges.

🤖 Claiming as part of a batched small-issue sweep this session (parallel worktrees, one PR per item). Will post a close comment per the Task Completion Protocol when its PR merges.
Author
Owner

✅ Merged via PR #449 (squash). Done: stripped the residual UTF-8 BOM from the 2 files in #269's set that still carried one — RemoveItemsFromCollectionHandler.cs, UpdateCollectionHandler.cs; the other 15 were already de-BOM'd by prior fix-as-you-touch work. Zero content change (charset=utf-8, #311). Build green. No docs change. Independent review exempt (mechanical).

✅ Merged via PR #449 (squash). **Done:** stripped the residual UTF-8 BOM from the 2 files in #269's set that still carried one — `RemoveItemsFromCollectionHandler.cs`, `UpdateCollectionHandler.cs`; the other 15 were already de-BOM'd by prior fix-as-you-touch work. Zero content change (charset=utf-8, #311). Build green. No docs change. Independent review exempt (mechanical).
timothy removed the in-progress label 2026-07-18 18:22:16 +02:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: timothy/ersatztv#310