Add include-regex option

[leaanthony-sc]

Description

Prior to packages configuration, it was possible to pass a regex to filter which interfaces are considered for mocking. This reintroduces the feature using the include-regex option for package configurations.

Example config:

packages:
  github.com/user/project:
    config:
      recursive: True
      include-regex: ".*Client"

In addition to this feature, a number of variables named packages have been renamed to packageList as they were clashing with package names.

• Fixes --name doesn't accept regex values #684

Type of change

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• This change requires a documentation update

Version of Golang used when building/testing:

• 1.21

How Has This Been Tested?

Tests have been added to config_test.go. These test the following scenarios:

all	include-regex	outcome
True	""	All interfaces match
True	".*Client"	All interfaces match. A warning is printed
False	".*Client"	Only interfaces ending in Client are generated

Checklist

• My code follows the style guidelines of this project
• I have performed a self-review of my code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes

[leaanthony-sc]

@LandonTClipp - I'm not super familiar with the codebase or coding style so feel free to make any suggestions/changes. Thanks for your time!

[LandonTClipp]

This is great, I actually don't have any concerns. It's basically exactly how I would have implemented it. Thanks for taking the time to do this!

[LandonTClipp]

Actually, just one minor doc change and we should be set.

[LandonTClipp]

Actually one thing I did miss, you'll want to also include this parameter in the configuration section of the docs in that large table.

[leaanthony-sc]

Docs updated 👍 I took the liberty of reformatting the markdown tables so they are easily readable in raw text. Can revert that if you want.

[leaanthony-sc]

@LandonTClipp Is there anything else you'd like adding to this or are we good to go? Thanks 🙏

[LandonTClipp]

Nothing else I think we need, I'll give it one last look this Monday and merge if it looks good.

Sorry, I have been on an extended camping trip out west and have not been focusing on coding much 😄