Merge pull request #116 from pharmaverse/101-set-up-styling-links-and-spelling-checks

Closes #101 set up styling links and spelling checks

Author: Ben Straub

.github/workflows/link_check.yml

@@ -0,0 +1,29 @@
+name: Links (Fail Fast)
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  linkChecker:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up R  # Install R from CRAN
+        uses: r-lib/actions/setup-r@v2
+        with:
+          r-version: '4.4.3' # You can specify a different R version if needed
+
+      - name: Install R packages
+        run: |
+          Rscript -e 'install.packages("fs")'
+        shell: bash
+
+      - name: Link Checker
+        uses: lycheeverse/lychee-action@v1.8.0
+        with:
+          fail: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/spellcheck.yml

@@ -0,0 +1,42 @@
+name: Spellcheck
+on:
+  pull_request:
+    branches: ['main']
+jobs:
+  Spelling:
+    runs-on: ubuntu-latest
+    container:
+      image: "rocker/tidyverse:4.3.1"
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Install packages
+        run: |
+          if (!require("roxygen2")) install.packages("roxygen2")
+          if (!require("spelling")) install.packages("spelling")
+          if (!require("testthat")) install.packages("testthat")
+        shell: Rscript {0}
+
+      - name: Check spelling
+        run: |
+          library(spelling)
+          
+          # Check the entire package (R files, documentation, vignettes, etc.)
+          words <- spelling::spell_check_package()
+          
+          print(words)
+          
+          testthat::test_that(desc = "Check spelling", code = {
+            testthat::expect_equal(
+              object = nrow(words),
+              expected = 0,
+              info = if (nrow(words) > 0) {
+                paste("Spelling errors found:\n", 
+                      paste(capture.output(print(words)), collapse = "\n"))
+              } else {
+                "No spelling errors"
+              }
+            )
+          })
+        shell: Rscript {0}

.github/workflows/style_check.yml

@@ -0,0 +1,20 @@
+name: Style
+on:
+  pull_request: {branches: ['main']}
+
+jobs:
+  Style:
+    runs-on: ubuntu-latest
+    container: {image: "rocker/tidyverse:4.2.1"}
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+      - name: Install styler
+        run: install.packages("styler")
+        shell: Rscript {0}
+      - name: styler version
+        run: packageVersion("styler")
+        shell: Rscript {0}
+      - name: Run styler
+        run: styler::style_dir(dry = "fail")
+        shell: Rscript {0}