gh-49: Add linting rules from exercises repo (#54)

Author: connoraird

.github/workflows/README.md

@@ -10,7 +10,7 @@ R console:
 
 ```r
 # Install/Update sandpaper
-options(repos = c(carpentries = "https://carpentries.r-universe.dev/", 
+options(repos = c(carpentries = "https://carpentries.r-universe.dev/",
   CRAN = "https://cloud.r-project.org"))
 install.packages("sandpaper")
 
@@ -34,21 +34,21 @@ This workflow does the following:
 
  1. checks out the lesson
  2. provisions the following resources
-   - R
-   - pandoc
-   - lesson infrastructure (stored in a cache)
-   - lesson dependencies if needed (stored in a cache)
+    - R
+    - pandoc
+    - lesson infrastructure (stored in a cache)
+    - lesson dependencies if needed (stored in a cache)
  3. builds the lesson via `sandpaper:::ci_deploy()`
 
 #### Caching
 
-This workflow has two caches; one cache is for the lesson infrastructure and 
-the other is for the the lesson dependencies if the lesson contains rendered
+This workflow has two caches; one cache is for the lesson infrastructure and
+the other is for the lesson dependencies if the lesson contains rendered
 content. These caches are invalidated by new versions of the infrastructure and
-the `renv.lock` file, respectively. If there is a problem with the cache, 
+the `renv.lock` file, respectively. If there is a problem with the cache,
 manual invaliation is necessary. You will need maintain access to the repository
 and you can either go to the actions tab and [click on the caches button to find
-and invalidate the failing cache](https://github.blog/changelog/2022-10-20-manage-caches-in-your-actions-workflows-from-web-interface/) 
+and invalidate the failing cache](https://github.blog/changelog/2022-10-20-manage-caches-in-your-actions-workflows-from-web-interface/)
 or by setting the `CACHE_VERSION` secret to the current date (which will
 invalidate all of the caches).
 
@@ -58,32 +58,32 @@ invalidate all of the caches).
 
 These workflows run on a schedule and at the maintainer's request. Because they
 create pull requests that update workflows/require the downstream actions to run,
-they need a special repository/organization secret token called 
-`SANDPAPER_WORKFLOW` and it must have the `public_repo` and `workflow` scope. 
+they need a special repository/organization secret token called
+`SANDPAPER_WORKFLOW` and it must have the `public_repo` and `workflow` scope.
 
 This can be an individual user token, OR it can be a trusted bot account. If you
 have a repository in one of the official Carpentries accounts, then you do not
 need to worry about this token being present because the Carpentries Core Team
 will take care of supplying this token.
 
-If you want to use your personal account: you can go to 
+If you want to use your personal account: you can go to
 <https://github.com/settings/tokens/new?scopes=public_repo,workflow&description=Sandpaper%20Token>
 to create a token. Once you have created your token, you should copy it to your
 clipboard and then go to your repository's settings > secrets > actions and
 create or edit the `SANDPAPER_WORKFLOW` secret, pasting in the generated token.
 
 If you do not specify your token correctly, the runs will not fail and they will
-give you instructions to provide the token for your repository. 
+give you instructions to provide the token for your repository.
 
 ### 02 Maintain: Update Workflow Files (update-workflow.yaml)
 
-The {sandpaper} repository was designed to do as much as possible to separate 
-the tools from the content. For local builds, this is absolutely true, but 
-there is a minor issue when it comes to workflow files: they must live inside 
-the repository. 
+The {sandpaper} repository was designed to do as much as possible to separate
+the tools from the content. For local builds, this is true, but
+there is a minor issue when it comes to workflow files: they must live inside
+the repository.
 
 This workflow ensures that the workflow files are up-to-date. The way it work is
-to download the update-workflows.sh script from GitHub and run it. The script 
+to download the update-workflows.sh script from GitHub and run it. The script
 will do the following:
 
 1. check the recorded version of sandpaper against the current version on github
@@ -100,25 +100,25 @@ This update is run weekly or on demand.
 
 For lessons that have generated content, we use {renv} to ensure that the output
 is stable. This is controlled by a single lockfile which documents the packages
-needed for the lesson and the version numbers. This workflow is skipped in 
+needed for the lesson and the version numbers. This workflow is skipped in
 lessons that do not have generated content.
 
 Because the lessons need to remain current with the package ecosystem, it's a
-good idea to make sure these packages can be updated periodically. The 
+good idea to make sure these packages can be updated periodically. The
 update cache workflow will do this by checking for updates, applying them in a
 branch called `updates/packages` and creating a pull request with _only the
-lockfile changed_. 
+lockfile changed_.
 
 From here, the markdown documents will be rebuilt and you can inspect what has
-changed based on how the packages have updated. 
+changed based on how the packages have updated.
 
 ## Pull Request and Review Management
 
-Because our lessons execute code, pull requests are a secruity risk for any
-lesson and thus have security measures associted with them. **Do not merge any
+Because our lessons execute code, pull requests are a security risk for any
+lesson and thus have security measures associated with them. **Do not merge any
 pull requests that do not pass checks and do not have bots commented on them.**
 
-This series of workflows all go together and are described in the following 
+This series of workflows all go together and are described in the following
 diagram and the below sections:
 
 ![Graph representation of a pull request](https://carpentries.github.io/sandpaper/articles/img/pr-flow.dot.svg)
@@ -129,22 +129,22 @@ This workflow runs every time a pull request is created and its purpose is to
 validate that the pull request is okay to run. This means the following things:
 
 1. The pull request does not contain modified workflow files
-2. If the pull request contains modified workflow files, it does not contain 
+2. If the pull request contains modified workflow files, it does not contain
    modified content files (such as a situation where @carpentries-bot will
    make an automated pull request)
 3. The pull request does not contain an invalid commit hash (e.g. from a fork
    that was made before a lesson was transitioned from styles to use the
    workbench).
 
-Once the checks are finished, a comment is issued to the pull request, which 
-will allow maintainers to determine if it is safe to run the 
+Once the checks are finished, a comment is issued to the pull request, which
+will allow maintainers to determine if it is safe to run the
 "Receive Pull Request" workflow from new contributors.
 
 ### Receive Pull Request (pr-receive.yaml)
 
 **Note of caution:** This workflow runs arbitrary code by anyone who creates a
 pull request. GitHub has safeguarded the token used in this workflow to have no
-priviledges in the repository, but we have taken precautions to protect against
+privileges in the repository, but we have taken precautions to protect against
 spoofing.
 
 This workflow is triggered with every push to a pull request. If this workflow
@@ -154,8 +154,8 @@ started.
 
 The first step of this workflow is to check if it is valid (e.g. that no
 workflow files have been modified). If there are workflow files that have been
-modified, a comment is made that indicates that the workflow is not run. If 
-both a workflow file and lesson content is modified, an error will occurr.
+modified, a comment is made that indicates that the workflow is not run. If
+both a workflow file and lesson content is modified, an error will occur.
 
 The second step (if valid) is to build the generated content from the pull
 request. This builds the content and uploads three artifacts:
@@ -164,7 +164,7 @@ request. This builds the content and uploads three artifacts:
 2. A summary of changes after the rendering process (diff)
 3. The rendered files (build)
 
-Because this workflow builds generated content, it follows the same general 
+Because this workflow builds generated content, it follows the same general
 process as the `sandpaper-main` workflow with the same caching mechanisms.
 
 The artifacts produced are used by the next workflow.
@@ -183,9 +183,9 @@ The steps in this workflow are:
 Importantly: if the pull request is invalid, the branch is not created so any
 malicious code is not published.
 
-From here, the maintainer can request changes from the author and eventually 
-either merge or reject the PR. When this happens, if the PR was valid, the 
-preview branch needs to be deleted. 
+From here, the maintainer can request changes from the author and eventually
+either merge or reject the PR. When this happens, if the PR was valid, the
+preview branch needs to be deleted.
 
 ### Send Close PR Signal (pr-close-signal.yaml)
 
@@ -194,5 +194,5 @@ pull request number for the next action
 
 ### Remove Pull Request Branch (pr-post-remove-branch.yaml)
 
-Tiggered by `pr-close-signal.yaml`. This removes the temporary branch associated with
+Triggered by `pr-close-signal.yaml`. This removes the temporary branch associated with
 the pull request (if it was created).

.github/workflows/linting.yaml

@@ -0,0 +1,32 @@
+---
+name: Linting
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    types:
+      - opened
+      - ready_for_review
+      - reopened
+      - synchronize
+
+concurrency:
+  cancel-in-progress: true
+  group: >-
+    ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+
+jobs:
+  linting:
+    if: github.event.pull_request.draft == false
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
+
+      - name: Install pre-commit and fortitude
+        run: python -m pip install -r requirements.txt
+
+      - name: Run pre-commit
+        run: prek run --all-files --color always --verbose

.markdownlint.yaml

@@ -0,0 +1,6 @@
+{
+  "default": true,
+  "MD013": { "line_length": 132 },
+  "MD024": false, # Multiple headings with the same content
+  "MD041": false, # First line in a file should be a top-level heading
+}

.pre-commit-config.yaml

@@ -0,0 +1,46 @@
+---
+repos:
+  - repo: https://github.com/PlasmaFAIR/fortitude-pre-commit
+    rev : v0.7.2
+    hooks:
+    - id: fortitude
+  - repo: https://github.com/crate-ci/typos
+    rev: v1.34.0
+    hooks:
+      - id: typos
+        args:
+          - --force-exclude
+          - --hidden
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.45.0
+    hooks:
+      - id: markdownlint-fix
+        args:
+          - --dot
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: check-added-large-files
+        args:
+          - --enforce-all
+          - --maxkb=1000
+        exclude: \.dic$
+      - id: check-case-conflict
+      - id: check-executables-have-shebangs
+      - id: check-merge-conflict
+      - id: check-shebang-scripts-are-executable
+      - id: destroyed-symlinks
+      - id: end-of-file-fixer
+      - id: mixed-line-ending
+        args:
+          - --fix=lf
+      - id: trailing-whitespace
+  - repo: https://github.com/errata-ai/vale
+    rev: v3.13.0
+    hooks:
+      - id: vale
+        name: vale sync
+        pass_filenames: false
+        args: [sync]
+      - id: vale
+        args: [--config=./.vale.ini]

.typos.toml

@@ -0,0 +1,7 @@
+[default]
+extend-ignore-re = [
+    # Custom ignore regex patterns:
+    # https://github.com/crate-ci/typos/blob/master/docs/reference.md#example-configurations
+    ".*(?:#|--|//|/*).*(?:typos):\\s?ignore[^\\n]*\\n",
+    ".*(?:typos):\\s?ignore-next-line[^\\n]*\\n[^\\n]*",
+]

.vale.ini

@@ -0,0 +1,36 @@
+StylesPath = .github/styles
+
+# https://github.com/errata-ai/packages
+Packages = proselint,\
+           RedHat,\
+           write-good
+
+[formats]
+qmd = md
+
+[*.{md,qmd}]
+BasedOnStyles = proselint,\
+                RedHat,\
+                Vale,\
+                write-good
+
+# Disable
+RedHat.Definitions = NO
+RedHat.Ellipses = NO
+RedHat.GitLinks = NO
+RedHat.Headings = NO
+RedHat.PascalCamelCase = NO
+RedHat.PassiveVoice = NO
+RedHat.ReadabilityGrade = NO
+RedHat.Slash = NO
+RedHat.Spelling = NO
+RedHat.TermsErrors = NO
+Vale.Spelling = NO
+write-good.E-Prime = NO
+write-good.Passive = NO
+write-good.TooWordy = NO
+write-good.ThereIs = NO
+
+# `vale sync` in CI means the packages are then linted, so turn them off
+[.github/styles/**]
+BasedOnStyles =

CITATION.cff

@@ -1,7 +1,7 @@
 # This template CITATION.cff file was generated with cffinit.
 # Visit https://bit.ly/cffinit to replace its contents
 # with information about your lesson.
-# Remember to update this file periodically, 
+# Remember to update this file periodically,
 # ensuring that the author list and other fields remain accurate.
 
 cff-version: 1.2.0

CODE_OF_CONDUCT.md

@@ -8,6 +8,5 @@ we pledge to follow the [The Carpentries Code of Conduct][coc].
 Instances of abusive, harassing, or otherwise unacceptable behavior
 may be reported by following our [reporting guidelines][coc-reporting].
 
-
 [coc-reporting]: https://docs.carpentries.org/topic_folders/policies/incident-reporting.html
 [coc]: https://docs.carpentries.org/topic_folders/policies/code-of-conduct.html

CONTRIBUTING.md

@@ -43,7 +43,6 @@ documentation][template-doc].
 2. If you wish to change the template used for workshop websites, please refer
    to [The Workbench documentation][template-doc].
 
-
 ### What to Contribute
 
 There are many ways to contribute, from writing new exercises and improving
@@ -107,17 +106,14 @@ email][contact].
 [contact]: mailto:team@carpentries.org
 [cp-site]: https://carpentries.org/
 [dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
-[dc-lessons]: https://datacarpentry.org/lessons/
 [dc-site]: https://datacarpentry.org/
-[discuss-list]: https://carpentries.topicbox.com/groups/discuss
 [github]: https://github.com
 [github-flow]: https://guides.github.com/introduction/flow/
 [github-join]: https://github.com/join
 [how-contribute]: https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github
 [issues]: https://carpentries.org/help-wanted-issues/
 [lc-issues]: https://github.com/issues?q=user%3ALibraryCarpentry
 [swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
-[swc-lessons]: https://software-carpentry.org/lessons/
 [swc-site]: https://software-carpentry.org/
 [lc-site]: https://librarycarpentry.org/
 [template-doc]: https://carpentries.github.io/workbench/

LICENSE.md

@@ -23,22 +23,22 @@ terms.
 Under the following terms:
 
 - **Attribution**---You must give appropriate credit (mentioning that your work
-  is derived from work that is Copyright (c) The Carpentries and, where
+  is derived from work that is Copyright © The Carpentries and, where
   practical, linking to <https://carpentries.org/>), provide a [link to the
   license][cc-by-human], and indicate if changes were made. You may do so in
   any reasonable manner, but not in any way that suggests the licensor endorses
   you or your use.
 
 - **No additional restrictions**---You may not apply legal terms or
   technological measures that legally restrict others from doing anything the
-  license permits.  With the understanding that:
+  license permits. With the understanding that:
 
 Notices:
 
-* You do not have to comply with the license for elements of the material in
+- You do not have to comply with the license for elements of the material in
   the public domain or where your use is permitted by an applicable exception
   or limitation.
-* No warranties are given. The license may not give you all of the permissions
+- No warranties are given. The license may not give you all of the permissions
   necessary for your intended use. For example, other rights such as publicity,
   privacy, or moral rights may limit how you use the material.
 
@@ -74,6 +74,5 @@ Carpentry" and their respective logos are registered trademarks of [The Carpentr
 [cc-by-human]: https://creativecommons.org/licenses/by/4.0/
 [cc-by-legal]: https://creativecommons.org/licenses/by/4.0/legalcode
 [mit-license]: https://opensource.org/licenses/mit-license.html
-[ci]: https://communityin.org/
 [osi]: https://opensource.org
 [the-carpentries]: https://carpentries.org