add superlinter #16

.github/workflows/linter.yaml

@@ -0,0 +1,55 @@
+---
+###########################
+###########################
+## Linter GitHub Actions ##
+###########################
+###########################
+name: Lint Code Base
+
+#
+# Documentation:
+# https://help.github.com/en/articles/workflow-syntax-for-github-actions
+#
+
+#############################
+# Start the job on all push #
+#############################
+on:
+  push:
+    branches-ignore: [master]
+    # Remove the line above to run when pushing to master
+  pull_request:
+    branches: [master]
+
+###############
+# Set the Job #
+###############
+jobs:
+  build:
+    # Name the Job
+    name: Lint Code Base
+    # Set the agent to run on
+    runs-on: ubuntu-latest
+
+    ##################
+    # Load all steps #
+    ##################
+    steps:
+      ##########################
+      # Checkout the code base #
+      ##########################
+      - name: Checkout Code
+        uses: actions/checkout@v2
+        with:
+          # Full git history is needed to get a proper list of changed files within `super-linter`
+          fetch-depth: 0
+
+      ################################
+      # Run Linter against code base #
+      ################################
+      - name: Lint Code Base
+        uses: github/super-linter@v3
+        env:
+          VALIDATE_ALL_CODEBASE: false
+          DEFAULT_BRANCH: master
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

NAMESPACE

@@ -16,4 +16,5 @@ export(remove_dep)
 export(use_codecov2)
 export(use_onbuild_image)
 export(use_radian)
+export(use_superlinter)
 export(view_url)

R/testing.R

@@ -1,7 +1,7 @@
 #' Set up codecov
 #' @param reposlug `[character(1)]`
 #' giving the `username/repo` URL slug of the project.
-#' @family testing functions
+#' @family quality control functions
 #' @export
 use_codecov2 <- function(reposlug) {
   usethis::use_coverage(type = "codecov")
@@ -12,3 +12,15 @@ use_codecov2 <- function(reposlug) {
   view_url("https://codecov.io/gh", reposlug, "settings")
   view_url("https://github.com", reposlug, "settings", "secrets")
 }
+
+#' Set up [super-linter](https://github.com/github/super-linter)
+#' @family quality control functions
+#' @export
+use_superlinter <- function() {
+  superlinter_url <- "https://github.com/marketplace/actions/super-linter"
+  usethis::ui_todo(c(
+    "Please add the {usethis::ui_code{'linter.yaml'} ",
+    "as described on {usethis::ui_code{superlinter_url}."
+  ))
+  view_url(superlinter_url)
+}

pkgdown/_pkgdown.yml

@@ -28,11 +28,11 @@ reference:
    Setting up RStudio and vscode.
 - contents:
   - has_concept("editor functions")
-- subtitle: Testing
+- subtitle: Quality Control
   desc: >
-    Set up unit testing.
+    Set up testing and linting.
 - contents:
-  - has_concept("testing functions")
+  - has_concept("quality control functions")
 - subtitle: Deployment
   desc: >
     Deploy muggle projects to the public cloud.