Spellcheck Action is a GitHub Action for checking the spelling of your Markdown, Python or plain text contents of your GitHub repository.
It is based on PySpelling a highly customizable Python implementation for use of aspell or hunspell.
Recently the action was updated to release 0.8.0 introducing the capability of customizing the configuration for working with the Markdown parsing.
The Markdown parsing is based on the Python Markdown project, used by PySpelling allows for configuration of the Markdown handling using the [pymdown-extensions] authored by the author of PySpelling.
pause
The funny thing about a GitHub Action like this one is that the action itself is actually just an integration between an existing piece of software and your GitHub repository. This mean that often you are at the mercy of the author of the core software you are using.
Luckly the author of PySpelling - facelessuser is keeping an eye on the Spellcheck Action repository for which I am the maintainer and he helps out whenever he can.
So when somebody reported an issue with a diagnostic like:
markdown: 'NoneType' object has no attribute 'end', please see issue #28 for all details
I was glad that facelessuser, stepped in an explained the issue and provided a solution.
Then I was not slow to:
- Add the missing components to the Docker image
- Add the diagnostic message to the documentation
- Ship a release 0.8.0 with the capability to configure the Markdown parts using the the
pymdown-extensions
Spellcheck Action now supports the use of the pymdown-extensions, so for example if your wanted to use the superfences extension, you could configure it as follows:
- pyspelling.filters.markdown:
markdown_extensions:
- pymdownx.superfences:
Current Spellcheck Action support the following extensions (in alphabetical order), which are now installed on the Docker image.
- Arithmatex
- B64
- BetterEm
- Caret
- Critic
- Details
- Emoji
- EscapeAll
- Extra
- Highlight
- InlineHilite
- Keys
- MagicLink
- Mark
- PathConverter
- ProgressBar
- SaneHeaders
- SmartSymbols
- Snippets
- StripHTML
- SuperFences
- Tabbed
- Tasklist
- Tilde
I do not know any of these extensions so I would refer to the documentation for the extensions for more details.
And currently only the case of use of superfences has been demonstrated by the issue mentioned above and outlined in this post.
Many thanks to:
- facelessuser for helping out and always providing actionable suggestions improving the Spellcheck Action
- and rfay for reporting the issue
Top comments (0)