Allow use_github_file() to work with non-text files#2173
Open
Allow use_github_file() to work with non-text files#2173
use_github_file() to work with non-text files#2173Conversation
Add mime dependency and update use_github_file() to handle both text and binary files by detecting MIME type. Fixes #1782
Need to read_utf() now since get_github_file() returns a path
ateucher
commented
Sep 19, 2025
| test_that("use_github_file works with non-text files", { | ||
| create_local_project() | ||
| use_github_file( | ||
| "https://github.com/r-lib/usethis/blob/main/man/figures/logo.png", |
Collaborator
Author
There was a problem hiding this comment.
I think this is probably stable, but I can put a small png in tests/testthat/ if that would be better?
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
1 participant
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.
Since text files are read with
read_utf8()and written to the final destination withwrite_over(), I changedread_github_file()toget_github_file()and instead of returning the text lines, it returns a path to a temp file, which requires usingread_utf8()in places it was used before.This adds
{mime}as a new dependency to detect the mimetype so we can branch on that: copy the file if it is binary, and read+write the lines if it is text.Happy to take a different approach if you have a better way!
I added one small test, which I can expand if this direction is ok.
Fixes #1782.