Merge pull request #415 from lorenzwalthert/visual-mode

Visual mode compliant markdown formatting

Author: lorenzwalthert

NEWS.md

@@ -6,15 +6,21 @@ editor_options:
 
 # precommit v0.3.0.9000
 
--   Fix bug that prevented pkg load outside directories with precommit files
-    (@mpadge, #413).
+-   Ensure sorting for `spell-check` hook is case-insensitive on all
+    operating systems. This may re-order your whole `inst/WORDLIST`
+    (#405).
+-   Fix bug that prevented pkg load outside directories with precommit
+    files (@mpadge, #413).
 -   hook `forbid-to-commit` in template `.pre-commit-config.yaml` has
-    now the correct `exclude-files` regular expression to ignore 
-    `.csv`, `.RData`, `.Rds`, `.rds` and `.Rhistory` (#410).
+    now the correct `exclude-files` regular expression to ignore `.csv`,
+    `.RData`, `.Rds`, `.rds` and `.Rhistory` (#410).
 -   `.pre-commit-config.yaml` templates now contain hook to validate the
     [pre-commit.ci](https://pre-commit.ci) configuration (#407).
 -   `options(install.packages.compile.from.source = "never")` is used in
-    the CI to avoid failing builds due to missing build-time deps (#412).
+    the CI to avoid failing builds due to missing build-time deps
+    (#412).
+-   All (R)md files in that repo are now formatted in a pandoc-compliant
+    way (#415).
 
 # precommit v0.3.0
 

README.Rmd

@@ -15,39 +15,23 @@ knitr::opts_chunk$set(
 
 <!-- badges: start -->
 
+[![CRAN status](https://www.r-pkg.org/badges/version/precommit)](https://CRAN.R-project.org/package=precommit) [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental) [![R build status](https://github.com/lorenzwalthert/precommit/workflows/R-CMD-check/badge.svg)](https://github.com/lorenzwalthert/precommit/actions)
 
-[![CRAN
-status](https://www.r-pkg.org/badges/version/precommit)](https://CRAN.R-project.org/package=precommit)
-[![Lifecycle:
-experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
-[![R build
-status](https://github.com/lorenzwalthert/precommit/workflows/R-CMD-check/badge.svg)](https://github.com/lorenzwalthert/precommit/actions)
 <!-- badges: end -->
 
+[Pre-commit hooks](https://pre-commit.com) are tests that run each time you attempt to commit. If the tests pass, the commit will be made, otherwise not. A very basic test is to check if the code is parsable, making sure you have not forgotten a comma, brace or quote. You can run hooks locally and/or in the cloud:
 
-[Pre-commit hooks](https://pre-commit.com) are tests that run each time you
-attempt to commit. If the tests pass, the commit will be made, otherwise not. A
-very basic test is to check if the code is parsable, making sure you have not
-forgotten a comma, brace or quote. You can run hooks locally and/or in the 
-cloud:
+-   As a check before local commits: This requires installing pre-commit.
 
-* As a check before local commits: This requires installing pre-commit.
-
-* As a CI check with  <https://pre-commit.ci>: If you want to enforce passing 
-  hooks on pull requests (and auto-fix trivial problems like styling) even if
-  the committer does not have a local installation.
- 
+-   As a CI check with <https://pre-commit.ci>: If you want to enforce passing hooks on pull requests (and auto-fix trivial problems like styling) even if the committer does not have a local installation.
 
 ## Goals of the package
 
 The goal of this package is to twofold:
 
-- Provide a [set of
-  hooks](https://lorenzwalthert.github.io/precommit/articles/available-hooks.html)
-  that are useful when your git repo contains R code.
+-   Provide a [set of hooks](https://lorenzwalthert.github.io/precommit/articles/available-hooks.html) that are useful when your git repo contains R code.
 
-- Provide [usethis](https://github.com/r-lib/usethis)-like functionality for
-  common tasks such as installation and set-up and config file modification.
+-   Provide [usethis](https://github.com/r-lib/usethis)-like functionality for common tasks such as installation and set-up and config file modification.
 
 ## Why do I need pre-commit hooks?
 
@@ -56,20 +40,14 @@ The goal of this package is to twofold:
 <figcaption>By <a href=https://twitter.com/dataandme/status/1255510799273132032>Mara Averick</a></figcaption>
 </figure>
 
-For a more in-depth explanation and even more reasons, see
-`vignette("why-use-hooks")`.
+For a more in-depth explanation and even more reasons, see `vignette("why-use-hooks")`.
 
-## Documentation 
+## Documentation
 
 The following online docs are available:
 
-- [latest CRAN release](https://lorenzwalthert.github.io/precommit/).
+-   [latest CRAN release](https://lorenzwalthert.github.io/precommit/).
 
-- [GitHub development
-  version](https://lorenzwalthert.github.io/precommit/dev/).
+-   [GitHub development version](https://lorenzwalthert.github.io/precommit/dev/).
 
-These only cover the functionality added on top of the pre-commit framework by
-this package. Everything else is covered in the extensive [online
-documentation](https://pre-commit.com) of the pre-commit framework itself,
-including how to create hooks for actions like `git push` or `git checkout`,
-create local hooks etc.
+These only cover the functionality added on top of the pre-commit framework by this package. Everything else is covered in the extensive [online documentation](https://pre-commit.com) of the pre-commit framework itself, including how to create hooks for actions like `git push` or `git checkout`, create local hooks etc.

README.md

@@ -11,6 +11,7 @@ status](https://www.r-pkg.org/badges/version/precommit)](https://CRAN.R-project.
 experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
 [![R build
 status](https://github.com/lorenzwalthert/precommit/workflows/R-CMD-check/badge.svg)](https://github.com/lorenzwalthert/precommit/actions)
+
 <!-- badges: end -->
 
 [Pre-commit hooks](https://pre-commit.com) are tests that run each time

cran-comments.md

@@ -2,15 +2,14 @@ This is a re-submission to failing tests caused by a roxygen 7.2.0.
 
 ## Test environments
 
-* ubuntu 18.04 (on GitHub Actions): R 4.2
-* Windows (on GitHub Actions): R 4.2
-* macOS (on GitHub Actions): R 4.2
-* win-builder: R devel
+-   ubuntu 18.04 (on GitHub Actions): R 4.2
+-   Windows (on GitHub Actions): R 4.2
+-   macOS (on GitHub Actions): R 4.2
+-   win-builder: R devel
 
 ## R CMD check results
 
-0 errors | 0 warnings | 0 notes
-
+0 errors \| 0 warnings \| 0 notes
 
 ## Downstream Dependencies
 

inst/WORDLIST

@@ -1,64 +1,21 @@
-Affero
-Averick
-CLI
-CMD
-Ctrl
-EOF
-Ei
-Eic
-Gitlab
-Homebrew
-IssueHunt
-KernSmooth
-Ko
-LF
-Liberapay
-Lifecycle
-MERCHANTABILITY
-Otechie
-Patreon
-RData
-RSMP
-RStudio
-Rbuildignore
-Rdata
-Rds
-Renviron
-Resubmission
-Rhistory
-Rnw
-RoxygenNote
-Rprofile
-Rproj
-Rr
-Rscript
-SHA
-Sublicensing
-Sys
-SystemRequirements
-Tidelift
-UCRT
-Uninstallation
-Unstaged
-Upvote
-VignetteBuilder
-WIPO
-Walthert
-Za
 ae
+Affero
 api
 appveyor
 arg
 args
 artific
 autoupdate
+Averick
 bd
 beaefa
 behaviour
 bliblablupp
 cfe
 ci
+CLI
 cli
+CMD
 cmd
 codemeta
 codemetar
@@ -73,21 +30,25 @@ copyrightable
 cp
 cran
 csv
+Ctrl
 dcf
 deps
 desc
 dev
 dir
 dirname
-docType
 docopt
 docsearch
+docType
 dontrun
 donttest
+Ei
+Eic
 elif
 emph
 entrypoint
 env
+EOF
 eval
 exlucded
 fi
@@ -100,9 +61,11 @@ getwd
 gh
 github
 gitignore
+Gitlab
 grDevices
 grepl
 gsub
+Homebrew
 href
 http
 https
@@ -112,17 +75,23 @@ impl
 init
 io
 isAvailable
-isTRUE
+IssueHunt
 issuehunt
+isTRUE
 jpeg
 json
+KernSmooth
 knitr
+Ko
 ko
 lang
 lapply
+LF
 lgpl
+Liberapay
 liberapay
 licensors
+Lifecycle
 lintr
 loadCache
 lorenz
@@ -132,6 +101,7 @@ macOS
 magrittr
 maxkb
 md
+MERCHANTABILITY
 mgcv
 miniconda
 mis
@@ -149,11 +119,14 @@ nt
 num
 oneliner
 os
+Otechie
 otechie
 overscope
 packageVersion
+pandoc
 params
 parsable
+Patreon
 patreon
 pkgapi
 pkgdown
@@ -166,63 +139,91 @@ precommithooks
 proj
 purrr
 py
-rR
+Rbuildignore
 rc
+RData
+Rdata
+Rds
 rds
 readLines
 readme
 recognised
 relicensing
 renv
+Renviron
 repo
 repos
+Resubmission
 reticulate
+Rhistory
 rlang
 rmarkdown
 rmd
+Rnw
 rnw
 roclet
 roclets
 ropenscilabs
 roxygen
 roxygenise
 roxygenize
+RoxygenNote
 rpart
+Rprofile
+Rproj
 rprojroot
+Rr
+rR
+Rscript
+RSMP
+RStudio
 rstudio
 rstudioapi
 saveCache
 seealso
 sep
 setdiff
+SHA
 stderr
 stdout
 sterr
 stopifnot
 styler
 sublicenses
+Sublicensing
+Sys
+SystemRequirements
 tcltk
 tempfile
 testthat
 tibble
+Tidelift
 tidelift
 tidyverse
 toolchain
 trailingOnly
 travis
 tryCatch
 ubuntu
+UCRT
 uninitialised
+Uninstallation
 unlist
 unname
+Unstaged
+Upvote
 usethis
 usr
+VignetteBuilder
+Walthert
 walthert
 wd
+WIPO
 withr
 wordlist
 writeLines
 www
 yaml
 yihui
 yml
+Za