rojopolis / spellcheck-github-actions

Spell check action
MIT License
138 stars 38 forks source link

How to apply spellcheck action on all markdown files of the repo ? #126

Closed baimamboukar closed 2 years ago

baimamboukar commented 2 years ago

Hello... I have successfuly integrate this action workflow in my project and It seems to be working very well 🚀!

I have several markdown files in different directories in my repository and I want to apply this action on all of them. How do I go about it ? What I mean, is having something like...

- source-files: README.md notes/*.md docs/*.md
facelessuser commented 2 years ago

I'm the author of the underlying pyspelling library which this action uses. If you are setting the config file directly, then such wild card patterns should work and is documented here https://facelessuser.github.io/pyspelling/configuration/#sources. The spellchecker action seems to provide a variable source_files (not source-files) that can be specified in the github action setup directly as an override, and I assume sends that directly to pyspelling, so it should behave the same and allow wildcard patterns.

I don't use the spellcheck-github-actions myself, but use pyspelling directly in my actions, so that is why I say things like "I assume".

baimamboukar commented 2 years ago

Thanks for helping ☄️

jonasbn commented 2 years ago

Hi @baimamboukar

If you want to see an example using the PySpelling configuration, please see:

Here I specify: sources: and both filter out and point to filename patterns, like so:

'!_site/*.md|!osx/list_available_voices_for_speechsynthesis.md|*/*.md'

I am closing this issue.