feat: spell check workflow (#76)

Author: felangel

.github/cspell.json

@@ -0,0 +1,18 @@
+{
+  "version": "0.2",
+  "$schema": "https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json",
+  "dictionaries": ["vgv_allowed", "vgv_forbidden"],
+  "dictionaryDefinitions": [
+    {
+      "name": "vgv_allowed",
+      "path": "https://raw.githubusercontent.com/verygoodopensource/very_good_dictionaries/main/allowed.txt",
+      "description": "Allowed VGV Spellings"
+    },
+    {
+      "name": "vgv_forbidden",
+      "path": "https://raw.githubusercontent.com/verygoodopensource/very_good_dictionaries/main/forbidden.txt",
+      "description": "Forbidden VGV Spellings"
+    }
+  ],
+  "useGitignore": true
+}

.github/workflows/ci.yml

@@ -35,6 +35,11 @@ jobs:
   verify-semantic-pull-request:
     uses: ./.github/workflows/semantic_pull_request.yml
 
+  verify-spell-check:
+    uses: ./.github/workflows/spell_check.yml
+    with:
+      modified_files_only: false
+
   build:
     needs:
       [
@@ -43,6 +48,7 @@ jobs:
         verify-pana-dart,
         verify-pana-flutter,
         verify-semantic-pull-request,
+        verify-spell-check,
       ]
 
     runs-on: ubuntu-latest

.github/workflows/spell_check.yml

@@ -0,0 +1,50 @@
+name: Spell Check Workflow
+
+on:
+  workflow_call:
+    inputs:
+      config:
+        required: false
+        type: string
+        default: ".github/cspell.json"
+      includes:
+        required: false
+        type: string
+        default: ""
+      runs_on:
+        required: false
+        type: string
+        default: "ubuntu-latest"
+      verbose:
+        required: false
+        type: boolean
+        default: false
+      modified_files_only:
+        required: false
+        type: boolean
+        default: true
+      working_directory:
+        required: false
+        type: string
+        default: "."
+
+jobs:
+  build:
+    defaults:
+      run:
+        working-directory: ${{inputs.working_directory}}
+
+    runs-on: ${{inputs.runs_on}}
+
+    steps:
+      - name: 📚 Git Checkout
+        uses: actions/checkout@v3
+
+      - name: 🪄 Spell Check
+        uses: streetsidesoftware/cspell-action@v2
+        with:
+          config: ${{inputs.config}}
+          files: ${{inputs.includes}}
+          incremental_files_only: ${{inputs.modified_files_only}}
+          root: ${{inputs.working_directory}}
+          verbose: ${{inputs.verbose}}

README.md

@@ -78,13 +78,13 @@ The Dart package workflow consists of the following steps:
 
 #### `analyze_directories`
 
-**Optional** A space seperated list of folders that should be analyzed.
+**Optional** A space separated list of folders that should be analyzed.
 
 **Default** `"lib test"`
 
 #### `report_on`
 
-**Optional** A comma seperated list of folders that should be checked in code coverage.
+**Optional** A comma separated list of folders that should be checked in code coverage.
 
 **Default** `"lib"`
 
@@ -274,6 +274,73 @@ jobs:
       working_directory: "examples/my_flutter_package"
 ```
 
+## Spell Check Workflow
+
+### Steps
+
+The spell check workflow consists of the following steps:
+
+1. Git Checkout
+2. Run Spell Check
+
+### Inputs
+
+#### `config`
+
+**Optional** The location of the `cspell.json`.
+
+**Default** `".github/cspell.json"`
+
+#### `includes`
+
+**Optional** The glob patterns to filter the files to be checked. Use a new line between patterns to define multiple patterns.
+
+**Default** `""`
+
+#### `working_directory`
+
+**Optional** The path to the root of the Dart package.
+
+**Default** `"."`
+
+#### `runs_on`
+
+**Optional** An optional operating system on which to run the workflow.
+
+**Default** `"ubuntu-latest"`
+
+#### `verbose`
+
+**Optional** An optional boolean which determines whether to log verbose output.
+
+**Default** `false`
+
+#### `modified_files_only`
+
+**Optional** An optional boolean which determines whether spell check is run on modified files.
+
+**Default** `true`
+
+### Example Usage
+
+```yaml
+name: My Workflow
+
+on: pull_request
+
+jobs:
+  build:
+    uses: VeryGoodOpenSource/very_good_workflows/.github/workflows/spell_check.yml@v1
+    with:
+      includes: |
+        **/*.{dart,md,yaml}
+        !.dart_tool/**/*.{dart,yaml}
+        .*/**/*.yml
+      runs_on: macos-latest
+      modified_files_only: false
+      working_directory: examples/my_project
+```
+
 [ci_badge]: https://github.com/VeryGoodOpenSource/very_good_workflows/actions/workflows/ci.yml/badge.svg
 [ci_link]: https://github.com/VeryGoodOpenSource/very_good_workflows/actions
 [github_workflows_link]: https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions