include list instead of exclude list

[DaniBodor]

Description

I have a project where I would like to only have a small number of files being checked for typos and the majority of files skipped. Is this possible to set up without listing each of the files/folders to skip separately?

[epage]

iirc we use gitignore syntax and you can "*", "!something" though there may be limitations.

[Kobzol]

Having a default include list would indeed be useful. I have a use-case (which I imagine might be relatively common) where I want to run typos both on CI (in check mode) and also provide a local script in the git repository (for "fix" -w mode), so that users can easily fix typos locally if CI finds some issues. That means that I have to either:

• Duplicate the list of directories to be checked in the GHA CI script and some in-repo bash script
• Invoke the git repo bash script from the CI workflow, but then I can't use the provided GH typos action

If it was possible to configure a default include list (that would either be appended or overwritten if you specify any paths in the typos command) in the TOML file, that would be nice.

[epage]

@Kobzol is there a problem with the inverting logic I mentioned? If not, you mentioned wanting this to be "default", implying it shouldn't need the inverting logic to achieve this. Is there a reason? Once its been configured, it shouldn't matter.

[Kobzol]

What you proposed works (thanks!), although it seems mostly as a workaround. Maybe it'd warrant at least a documentation mention, that it's the recommended way to simulate includes? Happy to send a PR if you agree.

[epage]

3c14191 provides an example of an include list using !

[Kobzol]

Thank you! I think that should be enough for most use-cases, now that it's documented.