Fix #86 -- Add support for an optional regex dependency

[yangcht]

Adding a regex example to find line-length issues of any non-comment part of the code.

[codingjoe]

Hi @yangcht,

Thank you for contributing to relint. I always love to see how people use this package.

Would you be so kind and split the cookbook suggestions and the new dependency into two pull-requests? Furthermore, I'd love to keep regex as an optional dependency. So maybe wrap it in a try block and add it to the package extras.

Since we don't actually ship any linting rules, having a separate dependency is not needed in all cases.

Please reach out to me if you require any assistance with that.

Best!
Joe

[yangcht]

Hi @codingjoe ,

Thanks for the nice suggestions! I have splitter the PR. I issued another PR for the cookbook change and made this PR only about the usage of the regex package.

[yangcht]

Hi @codingjoe, I have made the changs for the code plus some tests. Please have a look. Thanks!

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (f3049f7) to head (0b56dd6).
Report is 13 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main       #85   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            5         5           
  Lines          149       153    +4     
=========================================
+ Hits           149       153    +4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[codingjoe]

Hi @yangcht,

Thank you for your contribution. I had this lightly different in mind. Installing dependencies without a user's knowledge is dangerous. Besides, pip doesn't need to be installed on the system, so the command would fail.

Anyhow, I took the liberty to amend a couple of commits and to update the CI suite to test with regex installed.

Please let me know if this works for you, and I will merge and release this patch.

Best,
Joe

[yangcht]

Hi @codingjoe,

Thanks for the commits. I agree with your points. I just tested the new version, and it works well.
Please go ahead with the merge and release (the cookbook update is also in another PR).

Cheers,
Chentao