Get name suffix from the build.yaml file

[trejdych]

Hello, I'm not sure if it's the correct approach. I'd be happy to hear the feedback.

Closes #1851

[codecov]

Codecov Report

Merging #1898 (ba117a3) into master (f6e6e4d) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files

@@            Coverage Diff            @@
##            master     #1898   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            3         3           
  Lines           66        66           
=========================================
  Hits            66        66           

[trejdych]

I've marked it as ready for review however, I haven't written the test/tests because I... don't know how to do it. Is it possible?

[rrousselGit]

One way to test it is to make a separate project with a build.yaml dedicated for testing purposes.

There are also other ways of testing this that are more technical. If you fancy doing that, I invite you to look at how json_serializable does its tests.

One thing for sure is that a unit test for decoding the options would be neat.

[rrousselGit]

It's looking pretty good though!

[trejdych]

Thank you for the feedback! Please give me a few days. I would like to take a look at the json_serializable tests

[qoob23]

@trejdych @rrousselGit Hi! Appreciate your work! What do you think about also adding a prefix option?
I think that naming is a highly opinionated thing. For example, I use pattern providerOfSomething. This way by typing "provider" I'm getting a nice list of autocompletion suggestions.

Example config might look like this:

builders:
  riverpod_generator:
    options:
      provider_name_suffix: ""
      provider_name_prefix: "providerOf" # podOf, etc...

One thing to notice here is that this case will break scoping. So if an annotated function's name starts with "_" it should be moved to the beginning of the generated provider's name.
And the first letter should be also capitalized.

I can submit an update to this PR if you don't mind or open a new one:)

[trejdych]

Hello @rrousselGit Sorry for the long delay. I've had some private issues 🙈

I've added a sample project and a unit test.
I've checked source_gen_test and I'm not sure how to use it. :(
It uses _MockBuildStep under the hood which don't do anything. Riverpod depends on BuildStep and I can't inject "our" mock. Am I missing something?

@qoob23 another thing is the name case. Currently, the generator changes case to a lower camel case so for your options it would be providerOfsomeName. But I also think that prefix would be nice. It would make possible "spec_cli convention" $providerName which is nice too.

[rrousselGit]

I don't like this being in the root examples folder.
it probably should be in the riverpod_generator folder

[trejdych]

that makes more sense. I've just changed

[rrousselGit]

Don't worry about source_gen_test, we don't need that part. It's mostly for error handling, which we don't have here

LGTM if you can move the example to the generator folder

[rrousselGit]

Looks like the CI broke with your latest change

[trejdych]

I have no idea what's wrong with CI. there is a simple flutter analyze and it works well locally :/

[trejdych]

Hello, I've "fixed" the CI but there is a coverage problem... It is "covered" by the example project. Do you want me to add any more tests to increase code coverage?

BTW. I had to increase a timeout for the 'ensure_build' test.

[rrousselGit]

Thanks. I'll look into this later

[rrousselGit]

Looking good, Thanks!