chore(lib): continuation of v3 refactor (see #117)

[Rolv-Apneseth]

A continuation of and some fixes for the work started in #117

[Rolv-Apneseth]

I've pointed this to try and merge into the v3 branch so that #117 will still be a valid reference in the changelog - if you wish me to make a PR directly to main just let me know @jeertmans

[Rolv-Apneseth]

Also, I have not done any work related to the multiple requests as I figured that should be a separate PR

[jeertmans]

Impressive work @Rolv-Apneseth! I left a few comments here and there, but I think this is generally good. I see a lot of changes in the format: did you run cargo +nightly fmt? Because stable toolchain's format is quite different.

Also, it looks like a few tests are failing (MSRV, doc, ...), so it might be good to have them fixed before I can merge :-)

I think this is fine having a PR to v3, and then I will merge v3 is work is over. I agree that the split logic may be part of another PR :-)

[Rolv-Apneseth]

did you run cargo +nightly fmt

Ah, no, sorry I will do that. I will also have a look at the other issues later today

[Rolv-Apneseth]

That should hopefully be better, though I expect some will still fail. Also, I saw that on #117, the languagetool action running on *.rs files was giving a lot of false positives, should I have it only run on *.md files?

[Rolv-Apneseth]

Anything else you'd like me to do? I'll need help solving those remaining CI issues I think

[jeertmans]

I'll give it a deeper look later next week, and let you know @Rolv-Apneseth. Thanks for your work!

[Rolv-Apneseth]

Great, look forward to hearing from you. I'll just leave notes about 2 of the failing CI:

1. Benchmark

   Fails to compile the code before these changes, which makes sense - probably have to ignore this one for this PR?

2. Changelog

   The error leads to the readme of the create-or-update-comment action, which says:

   In public repositories this action does not work in pull_request workflows when triggered by forks. Any attempt will be met with the error, Resource not accessible by integration. This is due to token restrictions put in place by GitHub Actions.

   Guess that can't be done for this PR since it's from a fork.

[jeertmans]

Great, look forward to hearing from you. I'll just leave notes about 2 of the failing CI:

1. Benchmark
   Fails to compile the code before these changes, which makes sense - probably have to ignore this one for this PR?

This is probably just this, I'll double-check that during my review.

2. Changelog
   The error leads to the readme of the create-or-update-comment action, which says:

   In public repositories this action does not work in pull_request workflows when triggered by forks. Any attempt will be met with the error, Resource not accessible by integration. This is due to token restrictions put in place by GitHub Actions.

   Guess that can't be done for this PR since it's from a fork.

Yes, but I just should update the comment workflow (both for LanguageTool and for benchmarks) to allow failure, and use workflow summary instead, see how I do on another repository.

[jeertmans]

Hi @Rolv-Apneseth, thanks again for your work, and sorry for the delay in the review!

The PR looks great, however I have one last comment before I can merge, see my comment.

For the rest, as you mentioned, we will fix that in another PR :-)

[jeertmans]

Oops, I think the last await needs a manual casting map_err(Into::into) or something like that... I will fix that tomorrow :-)

[Rolv-Apneseth]

Oops, I think the last await needs a manual casting map_err(Into::into) or something like that... I will fix that tomorrow :-)

All good just did it there, talk to you tomorrow

[jeertmans]

Looks like this did the trick! Let's merge this, and discuss tomorrow about what are the next steps, if you are still interested to help of course :-)

Thanks for your help and patience on this one!

[Rolv-Apneseth]

Great :) and yes I'm still interested