rojopolis / spellcheck-github-actions

Spell check action
MIT License
138 stars 38 forks source link

Exclude directory from spell checker #26

Closed strongishllama closed 3 years ago

strongishllama commented 3 years ago

It would be great if we could exclude a directory from the spell checker. I've tried using the PySpelling configuration to do this, but it doesn't seem to work.

Thanks!

facelessuser commented 3 years ago

What have you tried? I'm the author of pyspelling, and that is usually the way to exclude directories.

strongishllama commented 3 years ago

This is what my .spellcheck.yml file looks like. I'm trying to ignore the assets directory.

matrix:
- name: Markdown
  aspell:
    lang: en
  dictionary:
    wordlists:
    - .wordlist.txt
    encoding: utf-8
  pipeline:
  - pyspelling.filters.markdown:
  - pyspelling.filters.html:
    comments: false
    ignores:
    - code
    - pre
  sources:
  - '**/*.md|!assets/*'
  default_encoding: utf-8
facelessuser commented 3 years ago

I guess you'll have to provide some example paths. I use similar logic in some of my own projects which works just fine: https://github.com/facelessuser/Rummage/blob/master/.pyspelling.yml#L82.

I'm also the author of the glob library that pyspelling uses (https://github.com/facelessuser/wcmatch), so if you can give some example paths, I can probably explain why it isn't working as expected. If I had to guess without seeing paths, you may need something like **/*.md|!assets/**, but I can't tell without some example paths.

strongishllama commented 3 years ago

That was it!! Thanks a lot for your help :+1: