Merge pull request #824 from JohannesNE/patch-1

- Treat .Rmarkdown files as .Rmd files (#824).

Author: lorenzwalthert

NEWS.md

@@ -2,6 +2,8 @@
 
 * Don't break line before comments in pipes (#822).
 
+* Files with `.Rmarkdown` extension are now recognised as an R markdown files in `style_file()` and friends (#824)
+
 # styler 1.5.1
 
 ## Alignment detection

R/set-assert-args.R

@@ -71,10 +71,10 @@ set_and_assert_arg_filetype <- function(filetype) {
 #' @importFrom rlang abort
 #' @keywords internal
 assert_filetype <- function(lowercase_filetype) {
-  if (!all(lowercase_filetype %in% c("r", "rmd", "rnw", "rprofile"))) {
+  if (!all(lowercase_filetype %in% c("r", "rmd", "rmarkdown", "rnw", "rprofile"))) {
     abort(paste(
       "filetype must not contain other values than 'R', 'Rprofile',",
-      "'Rmd' or 'Rnw' (case is ignored)."
+      "'Rmd', 'Rmarkdown' or 'Rnw' (case is ignored)."
     ))
   }
 }

R/ui-styling.R

@@ -6,7 +6,7 @@ NULL
 #' Prettify R source code
 #'
 #' Performs various substitutions in all `.R` files in a package
-#' (code and tests). One can also (optionally) style `.Rmd` and/or
+#' (code and tests). One can also (optionally) style `.Rmd`, `.Rmarkdown` and/or
 #' `.Rnw` files (vignettes and readme) by changing the `filetype` argument.
 #' Carefully examine the results after running this function!
 #'
@@ -95,7 +95,7 @@ style_pkg <- function(pkg = ".",
 #' @param filetype Vector of file extensions indicating which file types should
 #'   be styled. Case is ignored, and the `.` is optional, e.g.
 #'   `c(".R", ".Rmd")`, or `c("r", "rmd")`. Supported values (after
-#'   standardization) are: "r", "rprofile", "rmd", "rnw".
+#'   standardization) are: "r", "rprofile", "rmd", "rmarkdown", "rnw". Rmarkdown is treated as Rmd.
 #' @param exclude_files Character vector with paths to files that should be
 #'   excluded from styling.
 #' @param exclude_dirs Character vector with directories to exclude
@@ -138,6 +138,21 @@ prettify_pkg <- function(transformers,
     )
   }
 
+  if ("\\.rmarkdown" %in% filetype_) {
+    vignette_files <- append(
+      vignette_files,
+      dir_without_.(
+        path = "vignettes", pattern = "\\.rmarkdown$"
+      )
+    )
+    readme <- append(
+      readme,
+      dir_without_.(
+        path = ".", pattern = "^readme\\.rmarkdown$"
+      )
+    )
+  }
+
   if ("\\.rnw" %in% filetype_) {
     vignette_files <- append(
       vignette_files,
@@ -199,7 +214,7 @@ style_text <- function(text,
 
 #' Prettify arbitrary R code
 #'
-#' Performs various substitutions in all `.R`, `.Rmd` and/or `.Rnw` files
+#' Performs various substitutions in all `.R`, `.Rmd`, `.Rmarkdown` and/or `.Rnw` files
 #' in a directory (by default only `.R` files are styled - see `filetype` argument).
 #' Carefully examine the results after running this function!
 #' @param path Path to a directory with files to transform.
@@ -283,7 +298,7 @@ prettify_any <- function(transformers,
   )
 }
 
-#' Style `.R`, `.Rmd` or `.Rnw` files
+#' Style `.R`, `.Rmd`, `.Rmarkdown` or `.Rnw` files
 #'
 #' Performs various substitutions in the files specified.
 #' Carefully examine the results after running this function!

R/utils-files.R

@@ -6,7 +6,7 @@ is_rprofile_file <- function(path) {
   grepl(".rprofile", path, ignore.case = TRUE)
 }
 is_rmd_file <- function(path) {
-  grepl("\\.Rmd$", path, ignore.case = TRUE)
+  grepl("\\.(Rmd|Rmarkdown)$", path, ignore.case = TRUE)
 }
 
 is_rnw_file <- function(path) {

man/prettify_any.Rd

@@ -0,0 +1,30 @@
+---
+title: "random-rmd-script"
+author: "Lorenz Walthert"
+date: "11/25/2017"
+output: html_document
+---
+
+```{r setup, include=FALSE}
+1 + 1
+```
+
+## R Markdown
+
+This is an R Markdown document. Markdown is a simple formatting syntax for authoring HTML, PDF, and MS Word documents. For more details on using R Markdown see <http://rmarkdown.rstudio.com>.
+
+When you click the **Knit** button a document will be generated that includes both content as well as the output of any embedded R code chunks within the document. You can embed an R code chunk like this:
+
+```{r cars}
+summary(cars)
+```
+
+## Including Plots
+
+You can also embed plots, for example:
+
+```{r pressure, echo=FALSE}
+plot(pressure)
+```
+
+Note that the `echo = FALSE` parameter was added to the code chunk to prevent printing of the R code that generated the plot.