search

rojopolis / spellcheck-github-actions

Spell check action
MIT License
132 stars 38 forks source link

Action uses non-standard configuration location #109

Closed proffalken closed 2 years ago

proffalken commented 2 years ago

In order to ensure good developer experience, we want to allow developers to run the same commands on their workstations as is run by the CI.

Unfortunately this is not possible with spellcheck-github-actions, as it relies on .spellcheck.yaml whereas pyspellcheck relies on .pyspelling.yaml.

This means that we either cater to the github action and tell our developers to run pyspelling with the -c flag set, or we have to change the config for the action to explicitly include .pyspelling.yaml.

Given that the PySpelling default config location is .pyspelling.yaml it would be great if this file was also added to the list of default configuration files.

If people are open to this change, I'm more than happy to create the PR to fix it! :)

jonasbn commented 2 years ago

Hi @proffalken

Thanks for raising the issue, I will evaluate and get back to you.

jonasbn commented 2 years ago

As stated in the initial description the default configuration file for PySpelling is named: .pyspelling.yml.

REF: PySpelling documentation

jonasbn commented 2 years ago

Hi @proffalken

A PR would be most welcome.

Please be aware, that we might need to take into consideration both variations of YAML suffixes.

According to the documentation, *.yml is used, but in the code both are supported if I am not mistaken.

However since the parameter is feed to --config, we might as well accommodate for both, since they are both valid.