Use custom dictionary with hunspell

[joapuiib]

Hello,

I'm trying to configure this plugin to spell check my teaching site and need assistance.

I want to use hunspell, because there are dictionaries that support my language dialect with this tool: ca_Es_valencia

I've looked at the documentations and some examples, but I can't figure out how to use this custom dictionary.

• https://github.com/facelessuser/pyspelling/blob/master/.pyspelling.yml
• https://github.com/facelessuser/pymdown-extensions/blob/main/.pyspelling.yml

This is my current configuration:

spellchecker: hunspell

matrix:
  - name: mkdocs
    pipeline:
      - pyspelling.filters.html:
          comments: false
          attributes:
          - title
          - alt
          ignores:
          - ':matches(code, pre)'
          - 'a:matches(.magiclink-compare, .magiclink-commit, .magiclink-repository)'
          - '.md-social__link'
          - 'span.keys'
          - '.arithmatex, .md-nav__link, .md-footer-custom-text, .md-source__repository, .headerlink, .md-icon'
      - pyspelling.filters.url:
    sources:
      - site/**/*.html
    hunspell:
      # I've tested with -p option too
      d: docs/src/dictionary/hunspell/ca-ES-valencia.dic

Which gives the following error:

$ pyspelling
ERROR: site/apunts/01_introduccio/01_introduccio/index.html: html>body>div>footer>div>div>div.md-copyright -- Runtime Error: Can't open affix or dictionary files for dictionary named "docs/src/dictionary/hunspell/ca-ES-valencia.dic".

Anyone can give me some guidance on how to do this?

I'm trying this in a branch in my project, which can be found at: https://github.com/joapuiib/curs-git/tree/feature/spelling

Thanks in advance.

[joapuiib]

I've made some steps:

hunspell allows to set a DICPATH env variable to tell the location of dictionaries.

Modifying the config to:

    hunspell:
      d: ca-ES-valencia

And running pyspelling like this:

DICPATH="docs/src/dictionary/hunspell" pyspelling

Seems to work.

[joapuiib]

I've managed to run them locally!

Now I have a problem on GitHub Actions.
https://github.com/joapuiib/curs-git/actions/runs/11533116760/job/32105658295

In the spell cheking section it gives a lot of "Runtime Errors" with no additional information.

ERROR: site/apunts/01_introduccio/03_exercici/index.html: html>body>div>main>div>div>article>ol>li -- Runtime Error: 
Context: site/apunts/01_introduccio/03_exercici/index.html: html>body>div>main>div>div>article>ol>li

Any guidance on this?

[facelessuser]

Please explain how you are setting up your actions. My initial suggestion is to just look at what I'm doing in any my projects actions. Without knowing what you are doing, I can't really make suggestions.

[facelessuser]

If I had to guess, there's likely a problem calling Hunspell. We only issue Runtime errors in two places, and the one that makes the most sense is where we call an external command (like Hunspell).

[facelessuser]

    hunspell:
      r: True
      d: ca_ES_valencia,en_US

I'm also not sure how well -r plays with Pyspelling.

Have you tried running Pyspelling locally with the steps in your actions (at least the relevant steps)?

[joapuiib]

I've tested it locally, and it works, but there's a problem with -r option in actions.

Now, it works if -r is disabled.

I'll try to investigate a bit.
Thanks!

[facelessuser]

The library is just configured to parse noted bad words. Anything throwing a warning or error will make the library think this failed. Muddling the output with warnings will also likely confused the library.

[joapuiib]

Locally, no warnings were shown 🤷🏼‍♂️

[facelessuser]

We likely didn't forward the warning, but keep in mind, we don't support all the features offered by the spell checker in use. We only support returning misspelled word and notifying the user of said misspelled words.

We don't offer interactive replace, or replace in general. Other warning mechanism haven't been implemented. We just look for the returned bad words.