Merge pull request #117 from Appsilon/add-spell-check

Add spell check

.github/workflows/main.yml

@@ -47,6 +47,17 @@ jobs:
           lints <- lintr::lint_package()
           for (lint in lints) print(lint)
           quit(status = length(lints) > 0)
+
+      - name: Spell Check
+        if : always()
+        shell: Rscript {0}
+        run: |
+          spell_check <- spelling::spell_check_package(use_wordlist = TRUE)
+          if (nrow(spell_check) > 0) {
+            print(spell_check)
+          }
+          quit(status = nrow(spell_check) > 0)
+
       - name: Test coverage
         if: matrix.config.os == 'ubuntu-22.04' && matrix.config.r == 'release'
         run: |

DESCRIPTION

@@ -29,4 +29,5 @@ Suggests:
     covr,
     lintr,
     rcmdcheck,
+    spelling,
     testthat

R/logger.R

@@ -1,5 +1,5 @@
 #' Helper function to print out log messages into Shiny
-#' using cat() and stderr(), as described on
+#' using \code{cat()} and \code{stderr()}, as described on
 #' https://shiny.rstudio.com/articles/debugging.html
 #'
 #' Because this can print a lot, it's silent unless

R/pages.R

@@ -11,7 +11,7 @@ PAGE_404_ROUTE <- "404" #nolint
 #'
 #' The page which appear when path is wrong.
 #'
-#' @param page shiny page style, eg. \code{shiny::tags$div(h1("Not found"))}
+#' @param page shiny page style, e.g. \code{shiny::tags$div(h1("Not found"))}
 #' @param message404 message to display at the 404 website
 #'
 #' @export
@@ -33,7 +33,7 @@ page404 <- function(page = NULL, message404 = NULL) {
 #' Fix conflicts when some bookmark uses bootstrap
 #'
 #' This function dynamically removes bootstrap dependency when user opens specified bookmark.
-#' It should be inserted in head of bootrstrap page.
+#' It should be inserted in head of bootstrap page.
 #' @param bookmark Bookmark name on which bootstrap dependency should be suppressed.
 #'
 #' @importFrom htmltools renderDependencies resolveDependencies

R/paths.R

@@ -10,10 +10,10 @@ valid_path <- function(routes, path) {
   (path %in% names(routes))
 }
 
-#' Formats a URL fragment into a hashpath starting with "#!/"
+#' Formats a URL fragment into a hash path starting with "#!/"
 #'
 #' @param hashpath character with hash path
-#' @return character with formatted hashpath
+#' @return character with formatted hash path
 #' @keywords internal
 cleanup_hashpath <- function(hashpath) {
   hashpath <- hashpath[1]
@@ -71,7 +71,7 @@ route_link <- function(path) {
 #'  \item query, a list
 #' }
 #' @details
-#' \code{parse_url_path} allows parsing paramaters lists from url. See more in examples.
+#' \code{parse_url_path} allows parsing parameters lists from url. See more in examples.
 #'
 #' Note that having query string appear before \code{#!} may cause browser to refresh
 #' and thus reset Shiny session.

R/router.R

@@ -2,12 +2,12 @@ ROUTER_UI_ID <- '_router_ui' #nolint
 
 #' Attach 'router-hidden' class to single page UI content
 #'
-#' @description Covered UI types are Shiny/htmltools tags or tag lists and httml templates.
+#' @description Covered UI types are Shiny/htmltools tags or tag lists and html templates.
 #' In case of tag list (\code{tagList}) and html template (\code{htmlTemplate}) 'div' wrapper
 #' with 'router-hidden' class is added.
 #'
 #' @param ui Single page UI content created with proper html tags or tag list.
-#' @param path Single page path name. Attached to \code{data-path} attriubute.
+#' @param path Single page path name. Attached to \code{data-path} attribute.
 #' @keywords internal
 attach_attribs <- function(ui, path) {
   if ("shiny.tag" %in% class(ui)) {
@@ -187,7 +187,7 @@ create_router_callback <- function(root, routes = NULL) {
 #'   shiny modules.
 #'
 #' @details If you are defining the router inside a shiny module,
-#'   we assume that the namespacing function defined in the UI is named as ns.
+#'   we assume that the namespacing function defined in the UI is named as \code{ns}.
 #'
 #' @return Application UI wrapped in a router.
 #'
@@ -261,7 +261,7 @@ router_server_internal <- function(router) {
 #' @param router Router pages object. See \link{make_router}.
 #'
 #' @return list with shiny tags that adds "router-page-wrapper" div and embeds
-#' router javascript script.
+#' router JavaScript script.
 #' @keywords internal
 router_ui_internal <- function(router) {
   shiny::addResourcePath(
@@ -343,7 +343,7 @@ get_page <- function(session = shiny::getDefaultReactiveDomain()) {
 #'
 #' @param page The page to display. Should match one of the paths sent to the
 #' @param session Shiny session
-#' @param ... Other parameters are sent through to shiny::req()
+#' @param ... Other parameters are sent through to \code{shiny::req()}
 #' router.
 #' @export
 is_page <- function(page, session = shiny::getDefaultReactiveDomain(), ...) {
@@ -354,8 +354,8 @@ is_page <- function(page, session = shiny::getDefaultReactiveDomain(), ...) {
 #' Change the currently displayed page.
 #'
 #' Works by sending a message up to
-#' our reactive input binding on the clientside, which tells page.js to update
-#' the window URL accordingly, then tells clientside shiny that our reactive
+#' our reactive input binding on the client side, which tells page.js to update
+#' the window URL accordingly, then tells client side shiny that our reactive
 #' input binding has changed, then that comes back down to our router callback
 #' function and all other observers watching \code{get_page()} or similar.
 #'

R/zzz.R

@@ -1,7 +1,5 @@
 #' On Load
 #'
-#' On package load it updates .i18_config reading yaml file from config.
-#'
 #' @param libname library name
 #' @param pkgname package name
 #'

inst/WORDLIST

@@ -0,0 +1,23 @@
+Appsilon
+CMD
+RStudio
+UI
+appsilon
+codecov
+config
+cranlogs
+htmltools
+http
+https
+httr
+js
+minimalistic
+namespacing
+param
+params
+repo
+rstudio
+subpages
+ui
+webapp
+www