[mustache_template] Adopt code-excerpts for README

third_party/packages/mustache_template/CHANGELOG.md

@@ -1,3 +1,9 @@
+## 2.0.6
+
+* Adopts `code-excerpt` for the README's Dart snippets so they're validated
+  against compilable, analyzed source (fixes an invalid snippet and a
+  copy-pasted duplicate example that had gone unnoticed).
+
 ## 2.0.5
 
 * Updates metadata for move to https://github.com/flutter/core-packages.

third_party/packages/mustache_template/README.md

@@ -1,3 +1,5 @@
+<?code-excerpt path-base="example/lib"?>
+
 # Mustache templates
 
 A Dart library to parse and render [mustache templates](https://mustache.github.io/).
@@ -7,29 +9,27 @@ See the [mustache manual](https://mustache.github.io/mustache.5.html) for detail
 This library passes all [mustache specification](https://github.com/mustache/spec/tree/master/specs) tests.
 
 ## Example usage
+
+<?code-excerpt "main.dart (BasicUsage)"?>
 ```dart
-import 'package:mustache_template/mustache_template.dart';
-
-main() {
-	var source = '''
-	  {{# names }}
-            <div>{{ lastname }}, {{ firstname }}</div>
-	  {{/ names }}
-	  {{^ names }}
-	    <div>No names.</div>
-	  {{/ names }}
-	  {{! I am a comment. }}
-	''';
-
-	var template = Template(source, name: 'template-filename.html');
-
-	var output = template.renderString({'names': [
-		{'firstname': 'Greg', 'lastname': 'Lowe'},
-		{'firstname': 'Bob', 'lastname': 'Johnson'}
-	]});
-
-	print(output);
-}
+  const source = '''
+{{# names }}
+  <div>{{ lastname }}, {{ firstname }}</div>
+{{/ names }}
+{{^ names }}
+  <div>No names.</div>
+{{/ names }}
+{{! I am a comment. }}
+''';
+
+  final template = Template(source, name: 'template-filename.html');
+
+  final String output = template.renderString(<String, Object>{
+    'names': <Map<String, String>>[
+      <String, String>{'firstname': 'Greg', 'lastname': 'Lowe'},
+      <String, String>{'firstname': 'Bob', 'lastname': 'Johnson'},
+    ],
+  });
 ```
 
 A template is parsed when it is created, after parsing it can be rendered any number of times with different values. A TemplateException is thrown if there is a problem parsing or rendering the template.
@@ -53,65 +53,75 @@ By default all output from `{{variable}}` tags is html escaped, this behaviour c
 
 ## Nested paths
 
+<?code-excerpt "main.dart (NestedPaths)"?>
 ```dart
-  var t = Template('{{ author.name }}');
-  var output = template.renderString({'author': {'name': 'Greg Lowe'}});
+final template = Template('{{ author.name }}');
+final String output = template.renderString(<String, Object>{
+  'author': <String, String>{'name': 'Greg Lowe'},
+});
 ```
 
 ## Partials - example usage
 
+<?code-excerpt "main.dart (Partials)"?>
 ```dart
+final partial = Template('{{ foo }}', name: 'partial');
+
+Template? resolver(String name) {
+  if (name == 'partial-name') {
+    // Name of partial tag.
+    return partial;
+  }
+  return null;
+}
 
-var partial = Template('{{ foo }}', name: 'partial');
-
-var resolver = (String name) {
-   if (name == 'partial-name') { // Name of partial tag.
-     return partial;
-   }
-};
-
-var t = Template('{{> partial-name }}', partialResolver: resolver);
-
-var output = t.renderString({'foo': 'bar'}); // bar
+final template = Template('{{> partial-name }}', partialResolver: resolver);
 
+final String output = template.renderString(<String, String>{'foo': 'bar'}); // bar
 ```
 
 ## Lambdas - example usage
 
+<?code-excerpt "main.dart (LambdaReturningValue)"?>
 ```dart
-var t = Template('{{# foo }}');
-var lambda = (_) => 'bar';
-t.renderString({'foo': lambda}); // bar
-```
-
-```dart
-var t = Template('{{# foo }}hidden{{/ foo }}');
-var lambda = (_) => 'shown';
-t.renderString('foo': lambda); // shown
+final template = Template('{{# foo }}inner{{/ foo }}');
+Object lambda(Object? _) => 'bar';
+final String output = template.renderString(<String, Object>{'foo': lambda}); // bar
 ```
 
+<?code-excerpt "main.dart (LambdaHidingSection)"?>
 ```dart
-var t = Template('{{# foo }}oi{{/ foo }}');
-var lambda = (LambdaContext ctx) => '<b>${ctx.renderString().toUpperCase()}</b>';
-t.renderString({'foo': lambda}); // <b>OI</b>
+final template = Template('{{# foo }}hidden{{/ foo }}');
+Object lambda(Object? _) => 'shown';
+final String output = template.renderString(<String, Object>{'foo': lambda}); // shown
 ```
 
+<?code-excerpt "main.dart (LambdaWithContext)"?>
 ```dart
-var t = Template('{{# foo }}{{bar}}{{/ foo }}');
-var lambda = (LambdaContext ctx) => '<b>${ctx.renderString().toUpperCase()}</b>';
-t.renderString({'foo': lambda, 'bar': 'pub'}); // <b>PUB</b>
+final template = Template('{{# foo }}oi{{/ foo }}');
+Object lambda(LambdaContext ctx) => '<b>${ctx.renderString().toUpperCase()}</b>';
+final String output = template.renderString(<String, Object>{'foo': lambda}); // <b>OI</b>
 ```
 
+<?code-excerpt "main.dart (LambdaWithContextAndVariables)"?>
 ```dart
-var t = Template('{{# foo }}{{bar}}{{/ foo }}');
-var lambda = (LambdaContext ctx) => '<b>${ctx.renderString().toUpperCase()}</b>';
-t.renderString({'foo': lambda, 'bar': 'pub'}); // <b>PUB</b>
+final template = Template('{{# foo }}{{bar}}{{/ foo }}');
+Object lambda(LambdaContext ctx) => '<b>${ctx.renderString().toUpperCase()}</b>';
+final String output = template.renderString(<String, Object>{
+  'foo': lambda,
+  'bar': 'pub',
+}); // <b>PUB</b>
 ```
 
 In the following example `LambdaContext.renderSource(source)` re-parses the source string in the current context, this is the default behaviour in many mustache implementations. Since re-parsing the content is slow, and often not required, this library makes this step optional.
 
+<?code-excerpt "main.dart (LambdaReparsingSource)"?>
 ```dart
-var t = Template('{{# foo }}{{bar}}{{/ foo }}');
-var lambda = (LambdaContext ctx) => ctx.renderSource(ctx.source + ' {{cmd}}');
-t.renderString({'foo': lambda, 'bar': 'pub', 'cmd': 'build'}); // pub build
+final template = Template('{{# foo }}{{bar}}{{/ foo }}');
+Object lambda(LambdaContext ctx) => ctx.renderSource('${ctx.source} {{cmd}}');
+final String output = template.renderString(<String, Object>{
+  'foo': lambda,
+  'bar': 'pub',
+  'cmd': 'build',
+}); // pub build
 ```

third_party/packages/mustache_template/example/lib/main.dart

@@ -0,0 +1,119 @@
+// ignore_for_file: avoid_print
+
+import 'package:mustache_template/mustache_template.dart';
+
+void _basicUsage() {
+  // #docregion BasicUsage
+  const source = '''
+{{# names }}
+  <div>{{ lastname }}, {{ firstname }}</div>
+{{/ names }}
+{{^ names }}
+  <div>No names.</div>
+{{/ names }}
+{{! I am a comment. }}
+''';
+
+  final template = Template(source, name: 'template-filename.html');
+
+  final String output = template.renderString(<String, Object>{
+    'names': <Map<String, String>>[
+      <String, String>{'firstname': 'Greg', 'lastname': 'Lowe'},
+      <String, String>{'firstname': 'Bob', 'lastname': 'Johnson'},
+    ],
+  });
+  // #enddocregion BasicUsage
+  print(output);
+}
+
+void _nestedPaths() {
+  // #docregion NestedPaths
+  final template = Template('{{ author.name }}');
+  final String output = template.renderString(<String, Object>{
+    'author': <String, String>{'name': 'Greg Lowe'},
+  });
+  // #enddocregion NestedPaths
+  print(output);
+}
+
+void _partials() {
+  // #docregion Partials
+  final partial = Template('{{ foo }}', name: 'partial');
+
+  Template? resolver(String name) {
+    if (name == 'partial-name') {
+      // Name of partial tag.
+      return partial;
+    }
+    return null;
+  }
+
+  final template = Template('{{> partial-name }}', partialResolver: resolver);
+
+  final String output = template.renderString(<String, String>{'foo': 'bar'}); // bar
+  // #enddocregion Partials
+  print(output);
+}
+
+void _lambdaReturningValue() {
+  // #docregion LambdaReturningValue
+  final template = Template('{{# foo }}inner{{/ foo }}');
+  Object lambda(Object? _) => 'bar';
+  final String output = template.renderString(<String, Object>{'foo': lambda}); // bar
+  // #enddocregion LambdaReturningValue
+  print(output);
+}
+
+void _lambdaHidingSection() {
+  // #docregion LambdaHidingSection
+  final template = Template('{{# foo }}hidden{{/ foo }}');
+  Object lambda(Object? _) => 'shown';
+  final String output = template.renderString(<String, Object>{'foo': lambda}); // shown
+  // #enddocregion LambdaHidingSection
+  print(output);
+}
+
+void _lambdaWithContext() {
+  // #docregion LambdaWithContext
+  final template = Template('{{# foo }}oi{{/ foo }}');
+  Object lambda(LambdaContext ctx) => '<b>${ctx.renderString().toUpperCase()}</b>';
+  final String output = template.renderString(<String, Object>{'foo': lambda}); // <b>OI</b>
+  // #enddocregion LambdaWithContext
+  print(output);
+}
+
+void _lambdaWithContextAndVariables() {
+  // #docregion LambdaWithContextAndVariables
+  final template = Template('{{# foo }}{{bar}}{{/ foo }}');
+  Object lambda(LambdaContext ctx) => '<b>${ctx.renderString().toUpperCase()}</b>';
+  final String output = template.renderString(<String, Object>{
+    'foo': lambda,
+    'bar': 'pub',
+  }); // <b>PUB</b>
+  // #enddocregion LambdaWithContextAndVariables
+  print(output);
+}
+
+void _lambdaReparsingSource() {
+  // #docregion LambdaReparsingSource
+  final template = Template('{{# foo }}{{bar}}{{/ foo }}');
+  Object lambda(LambdaContext ctx) => ctx.renderSource('${ctx.source} {{cmd}}');
+  final String output = template.renderString(<String, Object>{
+    'foo': lambda,
+    'bar': 'pub',
+    'cmd': 'build',
+  }); // pub build
+  // #enddocregion LambdaReparsingSource
+  print(output);
+}
+
+void main() {
+  _basicUsage();
+  _nestedPaths();
+  _partials();
+  _lambdaReturningValue();
+  _lambdaHidingSection();
+  _lambdaWithContext();
+  _lambdaWithContextAndVariables();
+  _lambdaReparsingSource();
+}

third_party/packages/mustache_template/example/pubspec.yaml

@@ -0,0 +1,10 @@
+name: mustache_template_example
+description: Example code for the mustache_template package.
+publish_to: none
+
+environment:
+  sdk: ^3.10.0
+
+dependencies:
+  mustache_template:
+    path: ../

third_party/packages/mustache_template/pubspec.yaml

@@ -2,7 +2,7 @@ name: mustache_template
 description: A templating library that implements the Mustache template specification
 repository: https://github.com/flutter/core-packages/tree/main/third_party/packages/mustache_template
 issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+mustache_template%22
-version: 2.0.5
+version: 2.0.6
 
 environment:
   sdk: ^3.10.0