[go_router_builder] Add support for @TypedGoRouteParameter to customize parameter names

[ValentinVignal]

Relates to flutter/flutter#112152

Add support for @TypedGoRouteParameter to customize parameter names

Needs #10792 to get merged first

Pre-Review Checklist

• I read the Contributor Guide and followed the process outlined there for submitting PRs.
• I read the Tree Hygiene page, which explains my responsibilities.
• I read and followed the relevant style guides and ran the auto-formatter.
• I signed the CLA.
• The title of the PR starts with the name of the package surrounded by square brackets, e.g. [shared_preferences]
• I linked to at least one issue that this PR fixes in the description above.
• I updated pubspec.yaml with an appropriate new version according to the pub versioning philosophy, or I have commented below to indicate which version change exemption this PR falls under¹.
• I updated CHANGELOG.md to add a description of the change, following repository CHANGELOG style, or I have commented below to indicate which CHANGELOG exemption this PR falls under¹.
• I updated/added any relevant documentation (doc comments with ///).
• I added new tests to check the change I am making, or I have commented below to indicate which test exemption this PR falls under¹.
• All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel on Discord.

Note: The Flutter team is currently trialing the use of Gemini Code Assist for GitHub. Comments from the gemini-code-assist bot should not be taken as authoritative feedback from the Flutter team. If you find its comments useful you can update your code accordingly, but if you are unsure or disagree with the feedback, please feel free to wait for a Flutter team member's review for guidance on which automated comments should be addressed.

Footnotes

1. Regular contributors who have demonstrated familiarity with the repository guidelines only need to comment if the PR is not auto-exempted by repo tooling. ↩↩²↩³

[gemini-code-assist]

Code Review

This pull request introduces support for the @TypedGoRouteParameter annotation, allowing developers to customize the names of URL parameters in typed routes. The core change is a new uriName extension getter on FormalParameterElement which reads the custom name from the annotation or defaults to the kebab-case version of the field name. The code generator has been updated to use this new getter when constructing query parameters. The changes are well-tested with a new example and test cases. My feedback includes a suggestion to improve the readability of the code that extracts the annotation value.

[chunhtai]

Looking at the issue, is there a plan for custom converter?

[chunhtai]

should this be on the property declaration?

[ValentinVignal]

It was easier to put it in the parameter. But if you prefer, we can move it to the property instead. It will require a bit more code, though.

[chunhtai]

I think leave it here is fine, thinking about it more we may have inline declaration for constructor in the future dart language feature dart-lang/language#2364
so we not necessary have a standalone property declaration

[ValentinVignal]

Looking at the issue, is there a plan for custom converter?

Yes, thank you for asking. It made me realise I forgot to put a comment on the PR.

1. Ultimately, this annotation could have 2 more methods :

StringFunction(T) encode;
TFunction(String) decode;

but that will be for another PR. (Or it could be another annotation?)

2. We can introduce (in a future PR) a similar annotation for enum entries. Ex:

eum MyEnum {
@GoRouterEnumEntry(name:'customName1')
entry1,
@GoRouterEnumEntry(name:'custom_name_2')
entry2,
}

I'm not too proud of the name TypedGoRouteParameter, maybe you'd have a better name in mind?

[chunhtai]

I'm not too proud of the name TypedGoRouteParameter, maybe you'd have a better name in mind?

Maybe just call TypedQueryParameter? we don't have to stick the trademark on every class .

[chunhtai]

(also please use re-request review if you want me to take a look at the PR again)

[ValentinVignal]

Noted, I updated the name of the decorator to TypedQueryParameter

[chunhtai]

I like this. it make it a lot more readable.

I kinda wish we could have annotate each query parameter with this instead of relying on position parameter and named parameter. but I think that ship may have sailed for too long

[chunhtai]

we should add a test for this example to ensure it compiles

[ValentinVignal]

Makes sense, I added more tests in Update tests

[chunhtai]

When developer sets the name, are they expected to encode the string themself? we definitely need to document it here https://github.com/flutter/packages/pull/10792/files#diff-7d10b245947af9f5b39c2a5b1a064ac581386eb3efd95d1dae540a687afd4255R646

[ValentinVignal]

I'm not sure I understand the question. What so you mean by "encode the string themselve"?

[chunhtai]

if they want to use space in the name for some reason, should they provide name: 'q a', or name: 'q%20a'

[ValentinVignal]

Oh okay understood! They don't need to encode it themselves. Uri` does it for us.

In the end, it passes the name to uri:

final uri =Uri(
queryParameters: {
'withNoSpace': ['1'],
'with space': ['2'],
},
);
print(uri)

The example above yields

?withNoSpace=1&with+space=2

If the user names it q a, it will be transformed to q+a in the URL. Is this acceptable for you?

For example, I've updated the example (I'll push it soon) to be

@TypedGoRoute<IntRoute>(path:'/int-route')
classIntRouteextendsGoRouteDatawith$IntRoute {
IntRoute({
@TypedQueryParameter(name:'intField') this.intField,
@TypedQueryParameter(name:'int_field_with_default_value')
this.intFieldWithDefaultValue =1,
@TypedQueryParameter(name:'int field') this.intFieldWithSpace,
});

and here is what it looks like:

The url is /int-route?intField=1&int_field_with_default_value=2&int+field=2

[ValentinVignal]

I updated the changelogs here Update documentation, let me know if that's acceptable for you or not

[chunhtai]

updating the change log is good, but we should make sure the documentation also mentioned it.
i.e. here https://github.com/flutter/packages/pull/10792/files#diff-7d10b245947af9f5b39c2a5b1a064ac581386eb3efd95d1dae540a687afd4255R646

[chunhtai]

LGTM

[hannah-hyj]

LGTM