Respect system newline ending for hooks#1753
Merged
nathanjmcdougall merged 2 commits intomainfrom Apr 1, 2026
Merged
Conversation
Use os.linesep instead of hardcoded "\n" when constructing file content in hook scripts, and pass newline="" to I/O calls to prevent double-translation. Update the bespoke hook creation skill with newline handling guidance. Resolves #1792 Agent-Logs-Url: https://github.com/usethis-python/usethis-python/sessions/db9749a3-ce81-4ce8-8f12-b9e0d6c81012 Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix hooks to respect system newline ending
Respect system newline ending for hooks
Apr 1, 2026
nathanjmcdougall
approved these changes
Apr 1, 2026
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
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.
Hook scripts used hardcoded
"\n"for newline characters when constructing file content. Replace withos.linesepandnewline=""I/O to explicitly respect the OS newline convention.Hook changes
All five file-writing hooks (
export-functions,export-skills-directory,export-module-tree,fix-readme,fix-doc-sync) updated with the same pattern:newline=""is required on both read and write to prevent Python's text mode from double-translating\r\non Windows.read_text(newline=...)requires Python 3.13, so reads useopen()instead (project minimum is 3.10).For
fix-readme.py, Jinja2 renders with\ninternally, so conversion happens once aftertemplate.render(). Forfix-doc-sync.py,_build_replacement()usesos.linesepand all file I/O usesnewline="".Agent skill update
Added a "Newline endings" section to the
usethis-prek-hook-bespoke-createskill (v1.1 → v1.2) documenting theos.linesep+newline=""pattern for future hook authoring.