-
Notifications
You must be signed in to change notification settings - Fork 282
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
use_template()
no longer errors when a user chooses not to overwrite an existing file and instead produces a message
#350
Conversation
…tead of an error. Closes r-lib#348
R CMD check passing locally. Appveyor error:
travis error: usethis/tests/testthat/test-use-readme.R Lines 14 to 15 in bb191e9
Possibly clearing caches on both would help? |
It looks like I'll be doing a small release of usethis soon (e.g. within the month), prompted by the backports update, so I will sort out these things once I dig in. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just one small change. Otherwise, looks good.
Next time you probably be better off to make the PR from a non-master branch in your fork.
It will be interesting to see if the CI situation has improved, when you make a new commit. Various things that have nothing to do with your PR have (hopefully) been sorted out. I pass tests fine locally with this.
R/helpers.R
Outdated
@@ -45,7 +45,7 @@ use_template <- function(template, | |||
use_build_ignore(save_as) | |||
} | |||
|
|||
if (open) { | |||
if (open & new) { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This should be &&
.
Upon further thought, the failure on Travis re: Previously, we would have stopped inside In general, you need to do a survey of all existing uses of |
Thanks for the tip. Happy to characterize the scope of this. Hope to have some time near the end of this week to spend on this. Will that timing work? |
No worries, I might get to it sooner or not. But we have to sort it out before we can merge this. As you might see, I now think it's connected to another issue #178. |
I hope you don't mind me piping in here... With this PR, So the question is (specifically for My apologies if I'm off base or missed something obvious! |
This is some heavy yak-shaving, and possibly not very helpful, but here are the functions that call Most of them are just
library(tidyverse)
library(igraph, quietly = TRUE, warn.conflicts = FALSE)
library(usethis)
# devtools::install_github("ropenscilabs/revtools")
find_code_after_use_template <- function(x) {
x <- getFromNamespace(x, "usethis")
fn_body <- body(x)
# find where use_template is called
ut_block_no <- grep("use_template", fn_body)
if (length(ut_block_no) > 1) {
return("More than one call to use_template. Check this one out more carefully")
}
# if call to use_template is the last line, or the line after the call is a return-type statement
if (ut_block_no == length(fn_body) || grepl("^return|^invisible\\(", fn_body[ut_block_no + 1])) {
return(character(0))
}
# return the rest of the function body
as.character(fn_body[seq(ut_block_no + 1, length(fn_body))])
}
# Get character vector of exported function names that call use_template
funs_that_call_use_template <- revtools:::create_package_igraph("~/dev/packages/usethis/") %>%
as_long_data_frame() %>%
filter(to_name == "use_template") %>%
pull(from_name)
map(funs_that_call_use_template, find_code_after_use_template) %>%
set_names(funs_that_call_use_template) %>%
Filter(length, .)
#> $use_travis
#> [1] "travis_activate(browse)" "use_travis_badge()"
#> [3] "invisible(TRUE)"
#>
#> $use_appveyor
#> [1] "appveyor_activate(browse)" "use_appveyor_badge()"
#> [3] "invisible(TRUE)"
#>
#> $use_code_of_conduct
#> [1] "todo(\"Don't forget to describe the code of conduct in your README.md:\")"
#> [2] "code_block(\"Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md).\", \"By participating in this project you agree to abide by its terms.\")"
#>
#> $use_pipe
#> [1] "todo(\"Run \", code(\"document()\"))"
#>
#> $use_readme_rmd
#> [1] "if (uses_git()) {\n use_git_hook(\"pre-commit\", render_template(\"readme-rmd-pre-commit.sh\"))\n}"
#> [2] "invisible(TRUE)"
#>
#> $use_revdep
#> [1] "todo(\"Run checks with \", code(\"revdepcheck::revdep_check(num_workers = 4)\"))"
#>
#> $use_rmarkdown_template
#> [1] "More than one call to use_template. Check this one out more carefully"
#>
#> $use_rstudio
#> [1] "use_git_ignore(\".Rproj.user\")"
#> [2] "if (is_package()) {\n use_build_ignore(c(paste0(project_name(), \".Rproj\"), \".Rproj.user\"))\n}"
#> [3] "invisible(TRUE)"
#>
#> $use_tidy_ci
#> [1] "More than one call to use_template. Check this one out more carefully"
#>
#> $use_tidy_eval
#> [1] "todo(\"Run document()\")"
#>
#> $use_tidy_coc
#> [1] "todo(\"Don't forget to describe the code of conduct in your README.md:\")"
#> [2] "code_block(\"Please note that this project is released with a [Contributor Code of Conduct](.github/CODE_OF_CONDUCT.md).\", \"By participating in this project you agree to abide by its terms.\")" Created on 2018-05-30 by the reprex package (v0.2.0). |
Using @ateucher's handy scoping: use_travis and use_appveyorA user with an existing *.yml file here can safely choose not to overwrite because neither the active and badge functions depend on use_template failing when an overwrite does not occur use_readme_rmdI think the question here identified by @ateucher is:
I have skipped the readme_rmd test if R is less than 3.1 because it was trying to use use_rstudioThe main impact I see here is that calling This seems a little redundant so one could only call use_rmarkdown_template & use_tidy_ci.This functions without any adverse downstream effects and actually provides greater control if one wants to replace the .yaml but not the rmarkdown template (or vice versa). |
@jennybc Curious is it generally considered my responsibility to fix the merge conflicts that have arisen since the PR was originally submitted or is that usually left to the maintainer (you in this case)? |
You can leave it with me @boshek. |
Also a test to see if I can push to boshek/master
@boshek I'm working on this now and will try to finish things up in your PR. This means I'm going to be pushing to the branch you made it from (and have already done so). In future, you probably want to work in a non-master branch for PRs, but we'll just carry on with this. Are OK to just let me take over master branch of your fork for a little while? |
@jennybc Fine by me.
|
# Conflicts: # NEWS.md # R/helpers.R # R/write.R # tests/testthat/test-use-readme.R # tests/testthat/test-use-template.R
@boshek I think this is done. I'm just starting a vacation would like to wrap up this release before I do a complete mental check out. Will you sanity check this again, both by taking a look at the code I pushed and by confirming it still behaves the way you want? I'll be working through my other pre-release checklist items in parallel. Thanks! |
@ateucher Review by you, instead or in addition, is also welcome! |
@jennybc Looks great to me on both counts. Nothing odourous as far as I can see and the behaviour is exactly what I was after. Note: It isn't totally clear to me how this, this and this commit aren't in the boshek-master branch but are still part of the PR here. I assume this reflect my lack of understanding but am flagging this just in case. |
Thanks for taking a look!
That's a branch in this repo that I created by mistake, in some sense. I will delete it. The branch that matters for the PR is the |
Closes #348 Allow user to decline to overwrite existing file, from use_template()
write_over
so that it produces a message rather than an error whencan_overwrite()
isFALSE
NEWS
file outlining this small change (possibly not big enough to merit a NEWS item?)