Added support for PySpelling 2.11

Author: jonasbn

CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log for spellcheck-github-actions
 
+## 0.52.0, 2025-09-10, feature release, update not required
+
+- With version 2.11 of **PySpelling** a new command line option `--skip-dict-compile` is introduced to **PySpelling**  and is adopted by this action. This will skip the dictionary compiling step if the dictionary already exists. Changes to a custom dictionary will be ignored., see the [release notes for PySpelling](https://github.com/facelessuser/pyspelling/releases/tag/2.11). Do see the updated documentation for details.
+
+  - The feature can be enabled by setting the input parameter `skip_dict_compile` to `true`, the default is `false`, meaning that the dictionary will be compiled on each run of the action.
+  - This can save time if you have a large custom dictionary that does not change often.
+
 ## 0.51.0, 2025-06-20, maintenance release, update not required
 
 - Docker image updated to Python 3.13.5 slim via PR [#249](https://github.com/rojopolis/spellcheck-github-actions/pull/249) from Dependabot. [Release notes for Python 3.13.5](https://docs.python.org/release/3.13.5/whatsnew/changelog.html)

README.md

@@ -35,6 +35,7 @@ This action uses [PySpelling][pyspelling] to check spelling in source files in t
 - [Specifying Language and spellchecker](#specifying-language-and-spellchecker)
 - [Checking For Bad Spelling](#checking-for-bad-spelling)
 - [Language Support](#language-support)
+- [Configuring Action to Skip Custom Dictionary Compilation if Not Needed](#configuring-action-to-skip-custom-dictionary-compilation-if-not-needed)
 - [Tips](#tips)
   - [How to declutter your root directory from Spellcheck configuration files](#how-to-declutter-your-root-directory-from-spellcheck-configuration-files)
   - [Specify Code Not To Have Spelling Checked](#specify-code-not-to-have-spelling-checked)
@@ -108,7 +109,7 @@ jobs:
     steps:
     # The checkout step
     - uses: actions/checkout@v3
-    - uses: rojopolis/spellcheck-github-actions@0.51.0
+    - uses: rojopolis/spellcheck-github-actions@0.52.0
       name: Spellcheck
 ```
 
@@ -206,7 +207,7 @@ jobs:
     steps:
     # The checkout step
     - uses: actions/checkout@v3
-    - uses: rojopolis/spellcheck-github-actions@0.51.0
+    - uses: rojopolis/spellcheck-github-actions@0.52.0
       name: Spellcheck
       with:
         source_files: README.md CHANGELOG.md notes/Notes.md
@@ -234,7 +235,7 @@ jobs:
     steps:
     # The checkout step
     - uses: actions/checkout@v3
-    - uses: rojopolis/spellcheck-github-actions@0.51.0
+    - uses: rojopolis/spellcheck-github-actions@0.52.0
       name: Spellcheck
       with:
         source_files: README.md CHANGELOG.md notes/Notes.md
@@ -332,7 +333,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
-    - uses: rojopolis/spellcheck-github-actions@0.51.0
+    - uses: rojopolis/spellcheck-github-actions@0.52.0
       name: Spellcheck
       with:
         config_path: config/.spellcheck.yml # put path to configuration file here
@@ -463,7 +464,7 @@ See the documentation for [PySpelling](https://facelessuser.github.io/pyspelling
 The action can be specified to use `hunspell` instead of `aspell` by setting the `spellchecker` parameter to `hunspell`.
 
 ```yaml
-    - uses: rojopolis/spellcheck-github-actions@0.51.0
+    - uses: rojopolis/spellcheck-github-actions@0.52.0
       name: Spellcheck
       with:
         task_name: Markdown
@@ -550,6 +551,30 @@ Currently only the following languages are supported via [Hunspell][hunspell]:
 
 Additional languages can be added by request, please open an issue.
 
+## Configuring Action to Skip Custom Dictionary Compilation if Not Needed
+
+If you want to skip the compilation of the custom dictionary, you can set the `skip_dict_compile` input to `true` in your action configuration:
+
+```yaml
+name: Spellcheck Action
+on: push
+jobs:
+  build:
+    name: Spellcheck
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: rojopolis/spellcheck-github-actions@0.52.0
+      name: Spellcheck
+      with:
+        config_path: .github/spellcheck.yml
+        skip_dict_compile: true # <--- set to true to skip custom dictionary compilation
+```
+
+This can be useful if you have a large custom dictionary that does not change often, as it can save time during the action run.
+
+The feature was added in version `0.52.0` of the action and it can be disabled by setting the input to `false` or omitting it altogether. The default value is `false`.
+
 ## Tips
 
 ### How to declutter your root directory from Spellcheck configuration files
@@ -570,7 +595,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
-    - uses: rojopolis/spellcheck-github-actions@0.51.0
+    - uses: rojopolis/spellcheck-github-actions@0.52.0
       name: Spellcheck
       with:
         config_path: .github/spellcheck.yml # <--- put path to configuration file here
@@ -811,7 +836,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v3
-    - uses: rojopolis/spellcheck-github-actions@0.51.0
+    - uses: rojopolis/spellcheck-github-actions@0.52.0
       name: Spellcheck
 ```
 

action.yml

@@ -22,9 +22,15 @@ inputs:
     description: |
       The spell checker to use. Either `hunspell` or `aspell`.
     required: false
+  skip_dict_compile:
+    description: |
+      Skip dictionary compiling step if the dictionary already exists.
+      Changes to a custom dictionary will be ignored.
+      Accepts "true" or "false" and defaults to "false".
+    required: false
 branding:
   color: green
   icon: type
 runs:
   using: docker
-  image: 'docker://jonasbn/github-action-spellcheck:0.51.0'
+  image: 'docker://jonasbn/github-action-spellcheck:0.52.0'

entrypoint.sh

@@ -129,6 +129,23 @@ if [ -n "$INPUT_SPELL_CHECKER" ]; then
     fi
 fi
 
+SKIP_DICT_COMPILE='true'
+if [ -n "$INPUT_SKIP_DICT_COMPILE" ]; then
+    if [ "${INPUT_SKIP_DICT_COMPILE,,}" = "true" ]; then # lowercased INPUT_SKIP_DICT_COMPILE for caseinsensitive compare
+        echo "Skipping dictionary compilation via action configuration"
+        SKIP_DICT_COMPILE="true"
+    elif [ "${INPUT_SKIP_DICT_COMPILE,,}" = "false" ]; then # lowercased INPUT_SKIP_DICT_COMPILE for caseinsensitive compare
+        echo "Not skipping dictionary compilation via action configuration"
+    else
+        echo "Invalid value for skip_dict_compile, using default: false"
+    fi
+fi
+
+COMMAND="pyspelling --verbose"
+if [ "$SKIP_DICT_COMPILE" = "false" ]; then
+    COMMAND="$COMMAND --skip-dict-compile"
+fi
+
 EXITCODE=0
 
 # shellcheck disable=SC2086
@@ -137,16 +154,16 @@ EXITCODE=0
 # source and name are included in the parameters used
 
 if [ -n "$INPUT_OUTPUT_FILE" ] && [ -n "$SOURCES_LIST" ]; then
-    pyspelling --verbose --config "$SPELLCHECK_CONFIG_FILE" --spellchecker "$SPELL_CHECKER" $TASK_NAME $SOURCES_LIST | tee "$INPUT_OUTPUT_FILE"
+    $COMMAND --config "$SPELLCHECK_CONFIG_FILE" --spellchecker "$SPELL_CHECKER" $TASK_NAME $SOURCES_LIST | tee "$INPUT_OUTPUT_FILE"
     EXITCODE=${PIPESTATUS[0]}
 elif [ -n "$INPUT_OUTPUT_FILE" ]; then
-    pyspelling --verbose --config "$SPELLCHECK_CONFIG_FILE" --spellchecker "$SPELL_CHECKER" $TASK_NAME | tee "$INPUT_OUTPUT_FILE"
+    $COMMAND --config "$SPELLCHECK_CONFIG_FILE" --spellchecker "$SPELL_CHECKER" $TASK_NAME | tee "$INPUT_OUTPUT_FILE"
     EXITCODE=${PIPESTATUS[0]}
 elif [ -n "$SOURCES_LIST" ]; then
-    pyspelling --verbose --config "$SPELLCHECK_CONFIG_FILE" --spellchecker "$SPELL_CHECKER" $TASK_NAME $SOURCES_LIST
+    $COMMAND --config "$SPELLCHECK_CONFIG_FILE" --spellchecker "$SPELL_CHECKER" $TASK_NAME $SOURCES_LIST
     EXITCODE=$?
 elif [ -z "$INPUT_SOURCE_FILES" ]; then
-    pyspelling --verbose --config "$SPELLCHECK_CONFIG_FILE" --spellchecker "$SPELL_CHECKER" $TASK_NAME
+    $COMMAND --config "$SPELLCHECK_CONFIG_FILE" --spellchecker "$SPELL_CHECKER" $TASK_NAME
     EXITCODE=$?
 else
     echo "No files to check, exiting"

requirements.txt

@@ -5,7 +5,7 @@ html5lib==1.1
 lxml==5.3.0
 Markdown==3.7
 pymdown-extensions==10.15.0
-pyspelling==2.10
+pyspelling==2.11
 PyYAML==6.0.2
 six==1.16.0
 soupsieve==2.6