Spellcheck documentation

Author: lourot

.github/workflows/validate-on-push.yml

@@ -63,3 +63,14 @@ jobs:
         with:
           php_version: '8.1'
           command: test
+
+  spellchecker:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: borales/actions-yarn@v3
+        with:
+          cmd: install
+      - uses: borales/actions-yarn@v3
+        with:
+          cmd: spellcheck

.spelling

@@ -0,0 +1,34 @@
+# markdown-spellcheck spelling configuration file
+# Format - lines beginning # are comments
+# global dictionary is at the start, file overrides afterwards
+# one word per line, to define a file override use ' - filename'
+# where filename is relative to this configuration file
+PHPUnit
+WordPress
+PHP_CodeSniffer
+rulesets
+e.g.
+metadata
+i.e.
+1990s
+Exif
+2000s
+hardcrops
+hardcrop
+dchesterton
+5.6
+5.1
+subfolders
+subfolder
+composer.json
+namespace
+lourot
+frameright
+6.0
+GPLv3
+0.0.3
+changelog
+0.0.2
+2022-10-31
+0.0.1
+2022-10-27

README.md

@@ -37,7 +37,7 @@ rotated to best fit a given container. The
 Regions and insert them in the metadata of a picture.
 
 This WordPress plugin reads such Image Regions in order to automatically crop
-images the best possible way, dependending on which container they are being
+images the best possible way, depending on which container they are being
 displayed in.
 
 ## How does it work?

bin/yarn.sh

@@ -0,0 +1,14 @@
+#!/usr/bin/env sh
+
+# On some systems, 'yarn' is named 'yarnpkg', thus this wrapper.
+
+if which yarn; then
+    yarn "$@"
+    exit $?
+fi
+if which yarnpkg; then
+    yarnpkg "$@"
+    exit $?
+fi
+echo yarn not installed?
+exit 1

composer.json

@@ -3,7 +3,6 @@
     "phpunit/phpunit": "^9.5.25"
   },
   "scripts": {
-    "format": "yarn run prettier --write . || yarnpkg run prettier --write .",
     "lint": "./wpcs/vendor/bin/phpcs",
     "test": "./vendor/bin/phpunit"
   }

docs/contributing.md

@@ -1,8 +1,19 @@
 # Contributing
 
-## Running the unit tests
+## Code formatting
 
-### Setting up PHPUnit
+Pull and run [prettier](https://github.com/prettier/plugin-php) with:
+
+```bash
+$ yarn install  # pull
+$ yarn format   # run
+```
+
+## Validating
+
+### Running the unit tests
+
+#### Setting up PHPUnit
 
 Install [PHPUnit](https://phpunit.readthedocs.io/en/9.5/installation.html)
 with:
@@ -12,26 +23,17 @@ $ sudo apt install composer
 $ composer install
 ```
 
-### Running PHPUnit
+#### Running PHPUnit
 
 Run the unit tests with:
 
 ```bash
 $ composer test
 ```
 
-## Formatting the code
+### Validating against WordPress coding standards
 
-Pull and run [prettier](https://github.com/prettier/plugin-php) with:
-
-```bash
-$ yarn install     # pull
-$ composer format  # run
-```
-
-## Validating against WordPress coding standards
-
-### Setting up PHP_CodeSniffer
+#### Setting up PHP_CodeSniffer
 
 First pull the
 [WordPress coding standards](https://github.com/WordPress/WordPress-Coding-Standards)
@@ -74,15 +76,15 @@ $ docker run --rm -it --volume $PWD:/app -u `id -u`:`id -g` \
 $ popd
 ```
 
-### Running PHP_CodeSniffer
+#### Running PHP_CodeSniffer
 
 Run PHP_CodeSniffer with:
 
 ```bash
 $ composer lint
 ```
 
-## Building the plugin as a ZIP file
+### Building the plugin as a ZIP file
 
 Either build the package locally by committing your changes and running:
 
@@ -95,3 +97,13 @@ or push your branch up to GitHub and download it from
 e.g.
 https://github.com/Frameright/image-display-control-wordpress/archive/refs/heads/master.zip
 .
+
+### Spellchecking the documentation
+
+Pull and run [`mdspell`](https://github.com/lukeapage/node-markdown-spellcheck)
+with:
+
+```bash
+$ yarn install     # pull
+$ yarn spellcheck  # run
+```

package.json

@@ -1,6 +1,11 @@
 {
   "dependencies": {
     "@prettier/plugin-php": "^0.19.1",
-    "prettier": "^2.7.1"
+    "prettier": "^2.7.1",
+    "markdown-spellcheck": "^1.3.1"
+  },
+  "scripts": {
+    "format": "./bin/yarn.sh run prettier --write .",
+    "spellcheck": "./bin/yarn.sh run mdspell '**/*.md' 'readme.txt' '!node_modules/**' '!**/vendor/**' '!wpcs/**' --ignore-acronyms --no-suggestions --en-us"
   }
 }

readme.txt

@@ -19,7 +19,7 @@ of the image (e.g. objects, people) or for indicating how the image should be
 cropped or rotated to best fit a given container.
 
 This WordPress plugin reads such image regions in order to automatically crop
-images the best possible way, dependending on which container they are being
+images the best possible way, depending on which container they are being
 displayed in.
 
 The [Frameright app](https://frameright.app/) can be used to define such image