Add "Examples" .periphery.yml file with various case scenarios

[pouty18]

I'm loving the tool so far but trying to integrate it into a large production app has proved difficult. I would love if there was an examples directory where we could inspect various periphery yml files with expected outcomes.

For instance, I only want to use the tool to remove outdated files that are no longer referenced. However, I'd like to exclude any of the other issues from being reported...ie. functions, properties, parameters, enums, etc.

If there is a way where I can already see this being done that would be sweet.

[ileitch]

For instance, I only want to use the tool to remove outdated files that are no longer referenced.

Periphery doesn't identify unused files but the things declared within them. If you want to identify unused classes, structs, and enums, then you should be able to filter the results with a simple grep or by using the JSON output format and parsing the kind field.

There's no configuration option to achieve this so periphery.yml examples wouldn't help here. Maybe a new option like --filter-top-level could exclude any declarations that are members of another, e.g., instance methods and properties.