Ignore Module Prefix - Githubissues

akoutmos / doctor

Ensure that your Elixir project documentation is healthy

MIT License

180 stars 15 forks source link

Ignore Module Prefix #32

Closed kyleVsteger closed 3 years ago

kyleVsteger commented 3 years ago

Allows passage of ignore_module_prefixes: [Jason.Encoder, Mix.Tasks] to config
How do you want this tested? It works in the project that I've pulled it into 😄

akoutmos commented 3 years ago

Hey hey!! I'm loving this change and it is actually something that has been in the backlog for some time #23. Do you think you could drop the ignore_module_prefixes config value and make a function similar to filter_ignore_paths but for modules via RegEx? That would make it a bit more flexible and could filter out any sort of pattern beyond just prefixes.

akoutmos commented 3 years ago

I went ahead and snagged some of your changes and published the 0.16.0 release. For your particular example, you would do something like so in your .doctor.exs file to ignore all modules prefixed with the provided patterns:

%Doctor.Config{
  ignore_modules: [
    ~r(^Jason.Encoder),
    ~r(^Mix.Tasks)
  ],
  ...
}

Thanks for the contribution!