Warn if README.qmd does not exist in quarto websites (#287)

* issue #280: warn if README.qmd does not exist in quarto websites

* test

DESCRIPTION

@@ -1,7 +1,7 @@
 Type: Package
 Package: altdoc
 Title: Package Documentation Websites with 'Quarto', 'Docsify', 'Docute', or 'MkDocs'
-Version: 0.3.0.9004
+Version: 0.3.0.9005
 Authors@R: 
     c(person(given = "Etienne",
              family = "Bacher",

NEWS.md

@@ -28,6 +28,7 @@
   the `code-link` line in `altdoc/quarto_website.yml`
 * Citation is now formatted with HTML instead of verbatim (#282, Achim Zeileis).
 * The `\doi{}` tags in Rd files are now linked once rendered (#282, Achim Zeileis).
+* Warn if README.qmd does not exist when calling `setup_docs("quarto_website")`. Issue #280.
 
 
 

R/setup_docs.R

@@ -164,9 +164,15 @@ setup_docs <- function(tool, path = ".", overwrite = FALSE) {
   }
 
   # README.md is mandatory
-  fn <- fs::path_join(c(path, "README.md"))
+  if (tool == "quarto_website") {
+    fn <- "README.qmd"
+  } else {
+    fn <- "README.md"
+  }
+  msg <- sprintf("%s is mandatory. `altdoc` created a dummy README file in the package directory.", fn)
+  fn <- fs::path_join(c(path, fn))
   if (!fs::file_exists(fn)) {
-    cli::cli_alert_info("README.md is mandatory. `altdoc` created a dummy README file in the package directory.")
+    cli::cli_alert_info(msg)
     writeLines("Hello World!", fn)
   }
 }

tests/testthat/test-setup_docs.R

@@ -56,3 +56,11 @@ test_that("overwrite=TRUE works: mkdocs", {
     txt <- readLines("altdoc/mkdocs.yml", warn = FALSE)
     expect_false("Cruft" %in% txt)
 })
+
+test_that("quarto: README.qmd", {
+  create_local_package()
+  expect_false(file.exists("README.qmd"))
+  setup_docs("quarto_website", overwrite = TRUE)
+  expect_true(file.exists("README.qmd"))
+})
+