Merge pull request #597 from Appsilon/format-prettier

Add `format` functions based on `prettier`

.github/workflows/e2e-test.yml

@@ -101,12 +101,24 @@ jobs:
           cd RhinoApp
           Rscript ../test-lint-js.R
 
+      - name: format_js() should format JS scripts
+        if: always()
+        run: |
+          cd RhinoApp
+          Rscript ../test-format-js.R
+
       - name: lint_sass() should detect lint errors in CSS
         if: always()
         run: |
           cd RhinoApp
           Rscript ../test-lint-sass.R
 
+      - name: format_sass() should format SASS (.scss) scripts
+        if: always()
+        run: |
+          cd RhinoApp
+          Rscript ../test-format-sass.R
+
       - name: build_js() should build app.min.js
         if: always()
         run: |

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: rhino
 Title: A Framework for Enterprise Shiny Applications
-Version: 1.8.0.9000
+Version: 1.8.0.9001
 Authors@R:
   c(
     person("Kamil", "Żyła", role = c("aut", "cre"), email = "[email protected]"),
@@ -19,7 +19,7 @@ BugReports: https://github.com/Appsilon/rhino/issues
 License: LGPL-3
 Encoding: UTF-8
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.2.3
+RoxygenNote: 7.3.1
 Depends:
   R (>= 2.10)
 Imports:

NAMESPACE

@@ -4,7 +4,9 @@ export(app)
 export(build_js)
 export(build_sass)
 export(diagnostics)
+export(format_js)
 export(format_r)
+export(format_sass)
 export(init)
 export(lint_js)
 export(lint_r)

NEWS.md

@@ -1,6 +1,11 @@
 # rhino (development version)
 
 1. Added `sass: custom` configuration option for cleaner integration with `bslib`.
+2. Introduce `format_js()` and `format_sass()` powered by [prettier](https://prettier.io).
+    * **Migration**: Remove the `.rhino` directory if updating Rhino in an existing project.
+    * **Note:** `lint_js()` and `lint_sass()` report styling errors.
+      They _might_ complain about formatting done with `format_js()` and `format_sass()` functions; however, we haven't spotted any issues so far.
+      If you face any problems with this, then please [raise an issue on GitHub](https://github.com/Appsilon/rhino/issues/new/choose)
 
 # [rhino 1.8.0](https://github.com/Appsilon/rhino/releases/tag/v1.8.0)
 

R/tools.R

@@ -233,6 +233,29 @@ lint_js <- function(fix = FALSE) {
   }
 }
 
+#' Format JavaScript
+#'
+#' Runs [prettier](https://prettier.io/) on JavaScript files in `app/js` directory.
+#' Requires Node.js installed.
+#'
+#' You can prevent prettier from formatting a given chunk of your code by adding a special comment:
+#' ```js
+#' // prettier-ignore
+#' ```
+#' Read more about [ignoring code](https://prettier.io/docs/en/ignore).
+#'
+#' @param fix If `TRUE`, fixes formatting. If FALSE, reports formatting errors without fixing them.
+#' @return None. This function is called for side effects.
+#'
+#' @export
+format_js <- function(fix = TRUE) {
+  if (fix) {
+    npm("run", "format-js", "--", "--write")
+  } else {
+    npm("run", "format-js", "--", "--check")
+  }
+}
+
 #' Build Sass
 #'
 #' Builds the `app/styles/main.scss` file into `app/static/css/app.min.css`.
@@ -326,6 +349,29 @@ lint_sass <- function(fix = FALSE) {
   }
 }
 
+#' Format Sass
+#'
+#' Runs [prettier](https://prettier.io/) on Sass (.scss) files in `app/styles` directory.
+#' Requires Node.js installed.
+#'
+#' You can prevent prettier from formatting a given chunk of your code by adding a special comment:
+#' ```scss
+#' // prettier-ignore
+#' ```
+#' Read more about [ignoring code](https://prettier.io/docs/en/ignore).
+#'
+#' @param fix If `TRUE`, fixes formatting. If FALSE, reports formatting errors without fixing them.
+#' @return None. This function is called for side effects.
+#'
+#' @export
+format_sass <- function(fix = TRUE) {
+  if (fix) {
+    npm("run", "format-sass", "--", "--write")
+  } else {
+    npm("run", "format-sass", "--", "--check")
+  }
+}
+
 #' Run Cypress end-to-end tests
 #'
 #' Uses [Cypress](https://www.cypress.io/) to run end-to-end tests

inst/WORDLIST

@@ -54,6 +54,7 @@ renv
 roxygen
 rstudio
 scalable
+scss
 shinyapps
 shinymanager
 shinytest

inst/templates/node/package.json

@@ -5,6 +5,8 @@
     "build-sass": "sass --no-source-map --style=compressed ../app/styles/main.scss:../app/static/css/app.min.css",
     "lint-js": "eslint --config .eslintrc.json ../app/js",
     "lint-sass": "stylelint ../app/styles",
+    "format-js": "prettier --config prettier.config.mjs --ignore-path none ../app/js/**/*.js",
+    "format-sass": "prettier --config prettier.config.mjs --ignore-path none ../app/styles/**/*.scss",
     "run-app": "cd .. && Rscript -e \"shiny::runApp(port = 3333)\"",
     "run-cypress": "cypress run --project ../tests",
     "open-cypress": "cypress open --project ../tests",
@@ -22,6 +24,7 @@
     "eslint-config-airbnb": "^19.0.4",
     "eslint-import-resolver-webpack": "^0.13.8",
     "eslint-plugin-import": "^2.29.1",
+    "prettier": "^3.3.2",
     "sass": "^1.69.7",
     "start-server-and-test": "^2.0.3",
     "stylelint": "^14.16.1",

inst/templates/node/prettier.config.mjs

@@ -0,0 +1,11 @@
+/** @type {import("prettier").Config} */
+export default {
+  overrides: [
+    {
+      files: "../app/js/**/*.js",
+      options: {
+        singleQuote: true,
+      },
+    },
+  ],
+};

pkgdown/_pkgdown.yml

@@ -145,6 +145,8 @@ reference:
   - build_sass
   - lint_js
   - lint_sass
+  - format_js
+  - format_sass
   - react_component
 
 - title: Other tools

tests/e2e/test-format-js.R

@@ -0,0 +1,13 @@
+rhino::format_js()
+
+# Create bad scripts and test if formatting returns the expected result
+test_file_path <- fs::path("app", "js", "bad-style.js")
+cat('const  someFunction = (a ,b) => a+ b + "asdf"', file = test_file_path)
+rhino::format_js()
+testthat::expect_identical(
+  readLines(test_file_path),
+  "const someFunction = (a, b) => a + b + 'asdf';"
+)
+
+# Clean up
+file.remove(test_file_path)

tests/e2e/test-format-sass.R

@@ -0,0 +1,18 @@
+rhino::format_sass()
+
+# Create bad scripts and test if formatting returns the expected result
+test_file_path <- fs::path("app", "styles", "bad-style.scss")
+cat("@import 'asdf';\nx+y{ color: red}", file = test_file_path)
+rhino::format_sass()
+testthat::expect_identical(
+  readLines(test_file_path),
+  c(
+    '@import "asdf";',
+    "x + y {",
+    "  color: red;",
+    "}"
+  )
+)
+
+# Clean up
+file.remove(test_file_path)