[mustache_template] add example app and migrate README to excerpts by mozammal-hossain · Pull Request #11333 · flutter/packages

mozammal-hossain · 2026-03-23T16:16:15Z

This PR adds a runnable example/ app for mustache_template and migrates README usage snippets to excerpt-managed code from that example. This addresses the missing example app noted in the issue and aligns the package with the repository’s code-excerpt documentation pattern.

It also removes mustache_template from script/configs/temp_exclude_excerpt.yaml now that excerpt support is in place, and includes the corresponding version/CHANGELOG updates.

Fixes flutter/flutter#183936

Pre-Review Checklist

No new package logic was introduced; this change adds documentation/example structure and excerpt wiring, so no additional tests were added (test exemption).

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.

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

flutter-dashboard · 2026-03-23T16:16:19Z

It looks like this pull request may not have tests. Please make sure to add tests or get an explicit test exemption before merging.

If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix?

Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing. If you believe this PR qualifies for a test exemption, contact "@test-exemption-reviewer" in the #hackers channel in Discord (don't just cc them here, they won't see it!). The test exemption team is a small volunteer group, so all reviewers should feel empowered to ask for tests, without delegating that responsibility entirely to the test exemption group.

google-cla · 2026-03-23T16:16:26Z

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

gemini-code-assist

Code Review

This pull request updates the mustache_template package to version 2.0.4, introducing an example/ app to provide code snippets for the README.md via code-excerpt directives. The review notes that some nuanced lambda examples and documentation for LambdaContext.renderSource were removed from the README, and there's a syntax error in the docregion tags in example/main.dart that needs to be fixed.

third_party/packages/mustache_template/README.md

third_party/packages/mustache_template/example/main.dart

Updated the example in main.dart to fix the doc region tags for nested paths, ensuring proper documentation generation. This change enhances clarity and maintains consistency in the example code.

mozammal-hossain · 2026-03-23T17:10:27Z

Hi @ianloic, @precision, @sethladd, @romeo4934 — this PR is a docs/example update for mustache_template (restores nuanced lambda examples and LambdaContext.renderSource performance guidance), with no production/runtime behavior changes.

Could someone please:

approve the pending workflow run, and
provide the required review approval (if the content looks good)?

I also see tree-status is currently red; I’ll wait for tree reopen/normal merge guidance if needed.

stuartmorgan-g · 2026-03-23T20:45:50Z

@mozammal-hossain Do not ping random people in PRs.

You checked the box indicating that you read the contributing guidelines, which means you will have seen the multiple places where we say that reviews can take up to two weeks. Pinging people (especially the wrong people) almost immediately after opening the PR does not respect people's time, or our process.

bkonyi

LGTM overall with one question.

bkonyi · 2026-03-24T17:55:46Z

third_party/packages/mustache_template/example/main.dart

+
+import 'package:mustache_template/mustache_template.dart';
+
+// #docregion BasicRender


What's with these #docregion comments?

That's how our code excerpt system works.

docregion = document region.

That means - same code has been written on the documentation(package's README.md).

stuartmorgan-g

No new package logic was introduced; this change adds documentation/example structure and excerpt wiring, so no additional tests were added

There is a lot of new code, in example/lib/main.dart. There's no reason it can be exercised in a test that ensures that the snippets are actually showing working (not just compiling) code.

See an earlier attempt at this issue for examples of what tests might look like.

stuartmorgan-g · 2026-03-24T19:02:32Z

third_party/packages/mustache_template/README.md

-	print(output);
-}
-```
+Templates are parsed when created and can be rendered repeatedly with different


There's a lot of re-wrapping and re-wording of the README, which makes the diffs really hard to review. Please undo the README changes that aren't related to adopting snippets. If you believe the README needs rewriting, please file an issue describing why, and make a follow-up PR addressing it, so that we can evaluate those changes in isolation.

I've undo the README.md. (replace the README by This: LINK )

stuartmorgan-g · 2026-03-24T19:03:52Z

third_party/packages/mustache_template/README.md

 ```dart
-  var t = Template('{{ author.name }}');
-  var output = template.renderString({'author': {'name': 'Greg Lowe'}});
+void showStrictVsLenientBehavior() {


You've made all of the examples much longer without adding any substance, by including things like the print and the surrounding method definition. The excerpts should have the same scope they did before.

I’ve trimmed the README excerpts back to the minimal snippets

stuartmorgan-g

(Fixing review state; that was meant to be a "Request changes".)

…erpts and unit tests - Added an `example/` app with runnable usage samples. - Updated README examples to reference new excerpt-managed snippets. - Introduced unit tests for README code excerpts. - Moved excerpt sources to `example/lib/readme_excerpts.dart`. - Fixed a lambda example in the README to correct an invalid tag.

mozammal-hossain · 2026-03-25T04:05:11Z

No new package logic was introduced; this change adds documentation/example structure and excerpt wiring, so no additional tests were added

There is a lot of new code, in example/lib/main.dart. There's no reason it can be exercised in a test that ensures that the snippets are actually showing working (not just compiling) code.

See an earlier attempt at this issue for examples of what tests might look like.

I've added Test cases.

…m/mozammal-hossain/packages into fix/add-example-mustache-template * 'fix/add-example-mustache-template' of https://github.com/mozammal-hossain/packages: fix(mustache templates): Undo readme file

mozammal-hossain · 2026-03-25T04:36:34Z

(Fixing review state; that was meant to be a "Request changes".)

I've updated everything as per your suggestions. 😊

mustache_template: add example app and migrate README to excerpts

9b1652d

mozammal-hossain requested review from bkonyi and parlough as code owners March 23, 2026 16:16

github-actions bot added the p: mustache_template label Mar 23, 2026

gemini-code-assist bot reviewed Mar 23, 2026

View reviewed changes

third_party/packages/mustache_template/README.md Show resolved Hide resolved

third_party/packages/mustache_template/example/main.dart Outdated Show resolved Hide resolved

mozammal-hossain added 2 commits March 23, 2026 22:25

fix(mustache_template): correct doc region tags in example code

4b77fd2

Updated the example in main.dart to fix the doc region tags for nested paths, ensuring proper documentation generation. This change enhances clarity and maintains consistency in the example code.

feat(mustache_template): enhance README and examples with lambda usage

d39ef31

stuartmorgan-g changed the title ~~mustache_template: add example app and migrate README to excerpts~~ [mustache_template] add example app and migrate README to excerpts Mar 23, 2026

bkonyi approved these changes Mar 24, 2026

View reviewed changes

stuartmorgan-g reviewed Mar 24, 2026

View reviewed changes

stuartmorgan-g requested changes Mar 24, 2026

View reviewed changes

mozammal-hossain added 2 commits March 25, 2026 02:05

chore(mustache_template): Remove unnecessary function definition

f20d71f

mozammal-hossain added 3 commits March 25, 2026 10:25

fix(mustache templates): Undo readme file

061eed1

fix(mustache templates): Undo readme file

2ded2f9

Merge branch 'fix/add-example-mustache-template' of https://github.co…

272505c

…m/mozammal-hossain/packages into fix/add-example-mustache-template * 'fix/add-example-mustache-template' of https://github.com/mozammal-hossain/packages: fix(mustache templates): Undo readme file


		import 'package:mustache_template/mustache_template.dart';

		// #docregion BasicRender

Conversation

mozammal-hossain commented Mar 23, 2026

Pre-Review Checklist

Footnotes

Uh oh!

flutter-dashboard bot commented Mar 23, 2026

Uh oh!

google-cla bot commented Mar 23, 2026

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

Uh oh!

Uh oh!

mozammal-hossain commented Mar 23, 2026

Uh oh!

stuartmorgan-g commented Mar 23, 2026

Uh oh!

bkonyi left a comment

Choose a reason for hiding this comment

Uh oh!

bkonyi Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

mozammal-hossain Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g left a comment

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

mozammal-hossain Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

mozammal-hossain Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

stuartmorgan-g left a comment

Choose a reason for hiding this comment

Uh oh!

mozammal-hossain commented Mar 25, 2026

Uh oh!

mozammal-hossain commented Mar 25, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants