1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
|
#' Use roxygen2 with markdown
#'
#' If you are already using roxygen2, but not with markdown, you'll need to use
#' [roxygen2md](https://roxygen2md.r-lib.org) to convert existing Rd expressions
#' to markdown. The conversion is not perfect, so make sure to check the
#' results.
#'
#' @param overwrite Whether to overwrite an existing `Roxygen` field in
#' `DESCRIPTION` with `"list(markdown = TRUE)"`.
#'
#'
#' @export
use_roxygen_md <- function(overwrite = FALSE) {
check_installed("roxygen2")
if (!uses_roxygen()) {
roxy_ver <- as.character(utils::packageVersion("roxygen2"))
proj_desc_field_update("Roxygen", "list(markdown = TRUE)", overwrite = FALSE)
proj_desc_field_update("RoxygenNote", roxy_ver, overwrite = FALSE)
ui_bullets(c("_" = "Run {.run devtools::document()}."))
return(invisible())
}
already_setup <- uses_roxygen_md()
if (isTRUE(already_setup)) {
return(invisible())
}
if (isFALSE(already_setup) || isTRUE(overwrite)) {
proj_desc_field_update("Roxygen", "list(markdown = TRUE)", overwrite = TRUE)
check_installed("roxygen2md")
ui_bullets(c(
"_" = "Run {.run roxygen2md::roxygen2md()} to convert existing Rd
comments to markdown."
))
if (!uses_git()) {
ui_bullets(c(
"!" = "Consider using Git for greater visibility into and control over
the conversion process."
))
}
ui_bullets(c("_" = "Run {.run devtools::document()} when you're done."))
return(invisible())
}
ui_abort(c(
"DESCRIPTION already has a {.field Roxygen} field.",
"Delete that field and try again or call {.code use_roxygen_md(overwrite = TRUE)}."
))
invisible()
}
# FALSE: no Roxygen field
# TRUE: matches regex targetting 'markdown = TRUE', with some whitespace slop
# NA: everything else
uses_roxygen_md <- function() {
desc <- proj_desc()
if (!desc$has_fields("Roxygen")) {
return(FALSE)
}
roxygen <- desc$get_field("Roxygen", "")
if (grepl("markdown\\s*=\\s*TRUE", roxygen)) {
TRUE
} else {
NA
}
}
uses_roxygen <- function() {
proj_desc()$has_fields("RoxygenNote")
}
roxygen_ns_append <- function(tag) {
block_append(
tag,
glue("#' {tag}"),
path = proj_path(package_doc_path()),
block_start = "## usethis namespace: start",
block_end = "## usethis namespace: end",
block_suffix = "NULL",
sort = TRUE
)
}
roxygen_ns_show <- function() {
block_show(
path = proj_path(package_doc_path()),
block_start = "## usethis namespace: start",
block_end = "## usethis namespace: end"
)
}
roxygen_remind <- function() {
ui_bullets(c(
"_" = "Run {.run devtools::document()} to update {.path {pth('NAMESPACE')}}."
))
TRUE
}
roxygen_update_ns <- function(load = is_interactive()) {
ui_bullets(c("v" = "Writing {.path {pth('NAMESPACE')}}."))
utils::capture.output(
suppressMessages(roxygen2::roxygenise(proj_get(), "namespace"))
)
if (load) {
ui_bullets(c("v" = "Loading {.pkg {project_name()}}."))
pkgload::load_all(path = proj_get(), quiet = TRUE)
}
TRUE
}
# Checkers ----------------------------------------------------------------
check_uses_roxygen <- function(whos_asking) {
force(whos_asking)
if (uses_roxygen()) {
return(invisible())
}
whos_asking_fn <- sub("()", "", whos_asking, fixed = TRUE)
ui_abort(c(
"Package {.pkg {project_name()}} does not use roxygen2.",
"{.fun {whos_asking_fn}} can not work without it.",
"You might just need to run {.run devtools::document()} once, then try again."
))
}
|
