Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions tests/testthat/_snaps/vignette.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# use_vignette() gives useful errors

Code
use_vignette()
Error <simpleError>
argument "name" is missing, with no default
Code
use_vignette("bad name")
Error <usethis_error>
'bad name' is not a valid filename for a vignette. It must:
* Start with a letter.
* Contain only letters, numbers, '_', and '-'.

33 changes: 20 additions & 13 deletions tests/testthat/test-vignette.R
Original file line number Diff line number Diff line change
@@ -1,28 +1,25 @@
test_that("use_vignette() requires a package", {
skip_if_not_installed("rmarkdown")
# use_vignette ------------------------------------------------------------

test_that("use_vignette() requires a package", {
create_local_project()

expect_usethis_error(use_vignette(), "not an R package")
})

test_that("use_vignette() requires a `name`", {
skip_if_not_installed("rmarkdown")

test_that("use_vignette() gives useful errors", {
create_local_package()
expect_error(use_vignette(), "no default")
})

test_that("valid_vignette_name() works", {
expect_true(valid_vignette_name("perfectly-valid-name"))
expect_false(valid_vignette_name("01-test"))
expect_false(valid_vignette_name("test.1"))
expect_snapshot(error = TRUE, {
use_vignette()
use_vignette("bad name")
})
})

test_that("use_vignette() does the promised setup", {
skip_if_not_installed("rmarkdown")

create_local_package()

use_vignette("name", "title")
expect_proj_file("vignettes/name.Rmd")

ignores <- read_utf8(proj_path(".gitignore"))
expect_true("inst/doc" %in% ignores)
Expand All @@ -38,9 +35,19 @@ test_that("use_vignette() does the promised setup", {
)
})

# use_article -------------------------------------------------------------

test_that("use_article goes in article subdirectory", {
create_local_package()

use_article("test")
expect_proj_file("vignettes/articles/test.Rmd")
})

# helpers -----------------------------------------------------------------

test_that("valid_vignette_name() works", {
expect_true(valid_vignette_name("perfectly-valid-name"))
expect_false(valid_vignette_name("01-test"))
expect_false(valid_vignette_name("test.1"))
})