Setup the repo

.github/workflows/build-docker.yaml

@@ -0,0 +1,46 @@
+name: Build and push spellcheck image
+
+on:
+  push:
+    branches:
+      - main
+  pull-request:
+    branches:
+      - main
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: alexslemonade/spellcheck
+
+jobs:
+  build_and_push:
+    runs-on: ubuntu-22.04
+    permissions:
+      contents: read
+      packages: write
+    steps:
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Docker login
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Docker metadata
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          tags: |
+            type=semver,pattern={{raw}}
+            type=edge,branch=main
+
+      - name: Build and push to Docker
+        uses: docker/build-push-action@v5
+        with:
+          push: ${{ github.event.action == 'push' }
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.github/workflows/test.yaml

@@ -0,0 +1,19 @@
+on: [push]
+
+jobs:
+  spell-check:
+    runs-on: ubuntu-latest
+    name: Test the spell check action
+    steps:
+      # To use this repository's private action,
+      # you must check out the repository
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Spell check action
+        uses: ./ # Uses an action in the root directory
+        id: spell
+      # Use the output from the `spell check` step
+      - name: Get the number of errors
+        run: |
+          echo "There were ${{ steps.spell.outputs.error_count }} errors"
+          cat spell_check_errors.tsv

Dockerfile

@@ -0,0 +1,16 @@
+# A docker file for establishing a spellcheck environment in R
+FROM rocker/r-ver:4.3.2
+
+# Labels following the Open Containers Initiative (OCI) recommendations
+# For more information, see https://specs.opencontainers.org/image-spec/annotations/?v=v1.0.1
+LABEL org.opencontainers.image.authors="CCDL [email protected]"
+LABEL org.opencontainers.image.source="https://github.com/AlexsLemonade/spellcheck/tree/main"
+
+# install the spelling and tidyr packages from CRAN
+RUN Rscript -e "install.packages(c('readr', 'spelling', 'tidyr'))"
+
+# add spell check script and make it executable
+COPY spell-check.R /spell-check.R
+RUN chmod +x /spell-check.R
+
+ENTRYPOINT ["/spell-check.R"]

README.md

@@ -1,2 +1,6 @@
 # spellcheck
-This repository contains a Docker image with the R spelling package
+
+This repository contains a Docker image with the [R `spelling` package](https://cran.r-project.org/web/packages/spelling/index.html) installed.
+The role of this repository is to facilitate spell checking actions across `AlexsLemonade` repositories.
+
+speeling

action.yaml

@@ -0,0 +1,20 @@
+# action.yml
+name: 'R spell check'
+description: 'Spell check R, Rmd and md files'
+inputs:
+  dictionary:  # id of input
+    description: 'Dictionary file path'
+    required: true
+    default: 'components/dictionary.txt'
+  files:
+    description: Glob of files to check
+    required: false
+outputs:
+  error_count:
+    description: The number of spelling errors
+runs:
+  using: 'docker'
+  image: 'Dockerfile'
+  args:
+    - ${{ inputs.dictionary }}
+    - ${{ inputs.files }}

spell-check.R

@@ -0,0 +1,39 @@
+#!/usr/bin/env Rscript
+#
+# Run spell check and save results.
+# By default, all R Markdown and markdown files will be checked.
+# To modify this behavior, provide a command-line argument with the extensions to check.
+
+arguments <- commandArgs(trailingOnly = TRUE)
+file_pattern <- "\\.(Rmd|md|rmd)$"
+
+# dictionary is required first argument
+dict_file <- arguments[1]
+
+arguments <- arguments[-1]
+# if there are arguments, check those files, otherwise check all markdown & rmd files
+if (length(arguments) > 1) {
+  files <- arguments[grepl(file_pattern, arguments)]
+} else {
+  files <- list.files(pattern = file_pattern, recursive = TRUE, full.names = TRUE)
+}
+
+if (file.exists(dict_file)) {
+  dictionary <- readLines(dict_file)
+} else {
+  warning("Dictionary file not found")
+  dictionary <- ""
+}
+
+# Run spell check
+spelling_errors <- spelling::spell_check_files(files, ignore = dictionary) |>
+  data.frame() |>
+  tidyr::unnest(cols = found) |>
+  tidyr::separate(found, into = c("file", "lines"), sep = ":")
+
+
+# Save spelling errors to file
+readr::write_tsv(spelling_errors, "spell_check_errors.tsv")
+
+# Save error count to GITHUB_OUTPUT
+system(paste0("echo 'error_count=", nrow(spelling_errors), "'>> $GITHUB_OUTPUT"))