From 8cb9288d1116d8de22109d209eef3ec84e991525 Mon Sep 17 00:00:00 2001 From: Mike Date: Sat, 25 Nov 2023 21:35:18 -0800 Subject: [PATCH 1/5] [css_colors] Adopt code excerpts in README --- packages/css_colors/CHANGELOG.md | 3 ++- packages/css_colors/README.md | 4 +++- .../example/lib/readme_excerpts.dart | 17 ++++++++++++++ packages/css_colors/example/pubspec.yaml | 21 +++++++++++++++++ .../example/test/readme_excerpts_test.dart | 23 +++++++++++++++++++ packages/css_colors/pubspec.yaml | 2 +- script/configs/temp_exclude_excerpt.yaml | 1 - 7 files changed, 67 insertions(+), 4 deletions(-) create mode 100644 packages/css_colors/example/lib/readme_excerpts.dart create mode 100644 packages/css_colors/example/pubspec.yaml create mode 100644 packages/css_colors/example/test/readme_excerpts_test.dart diff --git a/packages/css_colors/CHANGELOG.md b/packages/css_colors/CHANGELOG.md index 44b20dbfd20..6e82f1e5286 100644 --- a/packages/css_colors/CHANGELOG.md +++ b/packages/css_colors/CHANGELOG.md @@ -1,6 +1,7 @@ -## NEXT +## 1.1.3+1 * Updates minimum supported SDK version to Flutter 3.10/Dart 3.0. +* Updates README to improve example of using `CSSColors`. ## 1.1.3 diff --git a/packages/css_colors/README.md b/packages/css_colors/README.md index 0cf989019d9..567c53e5fec 100644 --- a/packages/css_colors/README.md +++ b/packages/css_colors/README.md @@ -8,6 +8,7 @@ from `dart:ui`, which means they're useful for Flutter apps. Import ------ + ```dart import 'package:css_colors/css_colors.dart'; ``` @@ -15,6 +16,7 @@ import 'package:css_colors/css_colors.dart'; Use --- + ```dart -new Container(color: CSSColors.orange) +final Container orange = Container(color: CSSColors.orange); ``` diff --git a/packages/css_colors/example/lib/readme_excerpts.dart b/packages/css_colors/example/lib/readme_excerpts.dart new file mode 100644 index 00000000000..2606a6d429e --- /dev/null +++ b/packages/css_colors/example/lib/readme_excerpts.dart @@ -0,0 +1,17 @@ +// Copyright 2013 The Flutter Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +// #docregion Import +import 'package:css_colors/css_colors.dart'; +// #enddocregion Import +import 'package:flutter/material.dart'; + +/// Demonstrates using CSS Colors for the README. +Container useCSSColors() { + // #docregion Usage + final Container orange = Container(color: CSSColors.orange); + // #enddocregion Usage + + return orange; +} diff --git a/packages/css_colors/example/pubspec.yaml b/packages/css_colors/example/pubspec.yaml new file mode 100644 index 00000000000..5a304a06672 --- /dev/null +++ b/packages/css_colors/example/pubspec.yaml @@ -0,0 +1,21 @@ +name: css_colors_example +description: Demonstrates how to use CSS Colors. +publish_to: none + +environment: + sdk: ">=3.0.0 <4.0.0" + +dependencies: + css_colors: + # When depending on this package from a real application you should use: + # css_colors: ^x.y.z + # See https://dart.dev/tools/pub/dependencies#version-constraints + # The example app is bundled with the plugin so we use a path dependency on + # the parent directory to use the current plugin's version. + path: ../ + flutter: + sdk: flutter + +dev_dependencies: + flutter_test: + sdk: flutter diff --git a/packages/css_colors/example/test/readme_excerpts_test.dart b/packages/css_colors/example/test/readme_excerpts_test.dart new file mode 100644 index 00000000000..bb85447dcc4 --- /dev/null +++ b/packages/css_colors/example/test/readme_excerpts_test.dart @@ -0,0 +1,23 @@ +// Copyright 2013 The Flutter Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +import 'package:css_colors/css_colors.dart'; +import 'package:css_colors_example/readme_excerpts.dart'; +import 'package:flutter/material.dart'; +import 'package:flutter_test/flutter_test.dart'; + +void main() { + testWidgets('Container uses CSSColors.orange', (WidgetTester tester) async { + // Build the container and trigger a frame. + await tester.pumpWidget(MaterialApp(home: Scaffold(body: useCSSColors()))); + + // Verify that the Container has the correct color. + expect( + find.byWidgetPredicate( + (Widget widget) => + widget is Container && widget.color == CSSColors.orange, + ), + findsOneWidget); + }); +} diff --git a/packages/css_colors/pubspec.yaml b/packages/css_colors/pubspec.yaml index b28dea589a5..a1fb0b21d9f 100644 --- a/packages/css_colors/pubspec.yaml +++ b/packages/css_colors/pubspec.yaml @@ -2,7 +2,7 @@ name: css_colors description: Defines constant dart:ui Color objects for CSS colors (for use in Flutter code). repository: https://github.com/flutter/packages/tree/main/packages/css_colors issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+css_colors%22 -version: 1.1.3 +version: 1.1.3+1 environment: sdk: ">=3.0.0 <4.0.0" diff --git a/script/configs/temp_exclude_excerpt.yaml b/script/configs/temp_exclude_excerpt.yaml index c1fe3e9aa86..2cda5fb29b7 100644 --- a/script/configs/temp_exclude_excerpt.yaml +++ b/script/configs/temp_exclude_excerpt.yaml @@ -5,7 +5,6 @@ # TODO(stuartmorgan): Remove everything from this list. See # https://github.com/flutter/flutter/issues/102679 -- css_colors - espresso - extension_google_sign_in_as_googleapis_auth - flutter_image From 79b947c395a611cdf8d52bc05c90bbcbddb9fe4f Mon Sep 17 00:00:00 2001 From: Mike Date: Mon, 27 Nov 2023 11:40:53 -0800 Subject: [PATCH 2/5] fix new version number --- packages/css_colors/CHANGELOG.md | 2 +- packages/css_colors/pubspec.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/packages/css_colors/CHANGELOG.md b/packages/css_colors/CHANGELOG.md index 6e82f1e5286..3af2b5d0357 100644 --- a/packages/css_colors/CHANGELOG.md +++ b/packages/css_colors/CHANGELOG.md @@ -1,4 +1,4 @@ -## 1.1.3+1 +## 1.1.4 * Updates minimum supported SDK version to Flutter 3.10/Dart 3.0. * Updates README to improve example of using `CSSColors`. diff --git a/packages/css_colors/pubspec.yaml b/packages/css_colors/pubspec.yaml index a1fb0b21d9f..f39cb0ac556 100644 --- a/packages/css_colors/pubspec.yaml +++ b/packages/css_colors/pubspec.yaml @@ -2,7 +2,7 @@ name: css_colors description: Defines constant dart:ui Color objects for CSS colors (for use in Flutter code). repository: https://github.com/flutter/packages/tree/main/packages/css_colors issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+css_colors%22 -version: 1.1.3+1 +version: 1.1.4 environment: sdk: ">=3.0.0 <4.0.0" From c28d5484645818ff7a714689f160280eddd1eade Mon Sep 17 00:00:00 2001 From: Mike Date: Wed, 29 Nov 2023 14:45:42 -0800 Subject: [PATCH 3/5] fix CHANGELOG message --- packages/css_colors/CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/css_colors/CHANGELOG.md b/packages/css_colors/CHANGELOG.md index 3af2b5d0357..72fc00b91ca 100644 --- a/packages/css_colors/CHANGELOG.md +++ b/packages/css_colors/CHANGELOG.md @@ -1,7 +1,7 @@ ## 1.1.4 * Updates minimum supported SDK version to Flutter 3.10/Dart 3.0. -* Updates README to improve example of using `CSSColors`. +* Improves README example and updates it to use code excerpts. ## 1.1.3 From 07da910820db90e925b7e7661d30a3d72b4d684f Mon Sep 17 00:00:00 2001 From: Mike Date: Fri, 1 Dec 2023 12:18:31 -0800 Subject: [PATCH 4/5] Move code excerpts from example folder to test folder --- packages/css_colors/README.md | 4 ++-- .../example/lib/readme_excerpts.dart | 17 -------------- packages/css_colors/example/pubspec.yaml | 21 ----------------- .../example/test/readme_excerpts_test.dart | 23 ------------------- packages/css_colors/pubspec.yaml | 2 ++ packages/css_colors/test/css_colors_test.dart | 22 ++++++++++++++++++ 6 files changed, 26 insertions(+), 63 deletions(-) delete mode 100644 packages/css_colors/example/lib/readme_excerpts.dart delete mode 100644 packages/css_colors/example/pubspec.yaml delete mode 100644 packages/css_colors/example/test/readme_excerpts_test.dart create mode 100644 packages/css_colors/test/css_colors_test.dart diff --git a/packages/css_colors/README.md b/packages/css_colors/README.md index 567c53e5fec..2a145141498 100644 --- a/packages/css_colors/README.md +++ b/packages/css_colors/README.md @@ -8,7 +8,7 @@ from `dart:ui`, which means they're useful for Flutter apps. Import ------ - + ```dart import 'package:css_colors/css_colors.dart'; ``` @@ -16,7 +16,7 @@ import 'package:css_colors/css_colors.dart'; Use --- - + ```dart final Container orange = Container(color: CSSColors.orange); ``` diff --git a/packages/css_colors/example/lib/readme_excerpts.dart b/packages/css_colors/example/lib/readme_excerpts.dart deleted file mode 100644 index 2606a6d429e..00000000000 --- a/packages/css_colors/example/lib/readme_excerpts.dart +++ /dev/null @@ -1,17 +0,0 @@ -// Copyright 2013 The Flutter Authors. All rights reserved. -// Use of this source code is governed by a BSD-style license that can be -// found in the LICENSE file. - -// #docregion Import -import 'package:css_colors/css_colors.dart'; -// #enddocregion Import -import 'package:flutter/material.dart'; - -/// Demonstrates using CSS Colors for the README. -Container useCSSColors() { - // #docregion Usage - final Container orange = Container(color: CSSColors.orange); - // #enddocregion Usage - - return orange; -} diff --git a/packages/css_colors/example/pubspec.yaml b/packages/css_colors/example/pubspec.yaml deleted file mode 100644 index 5a304a06672..00000000000 --- a/packages/css_colors/example/pubspec.yaml +++ /dev/null @@ -1,21 +0,0 @@ -name: css_colors_example -description: Demonstrates how to use CSS Colors. -publish_to: none - -environment: - sdk: ">=3.0.0 <4.0.0" - -dependencies: - css_colors: - # When depending on this package from a real application you should use: - # css_colors: ^x.y.z - # See https://dart.dev/tools/pub/dependencies#version-constraints - # The example app is bundled with the plugin so we use a path dependency on - # the parent directory to use the current plugin's version. - path: ../ - flutter: - sdk: flutter - -dev_dependencies: - flutter_test: - sdk: flutter diff --git a/packages/css_colors/example/test/readme_excerpts_test.dart b/packages/css_colors/example/test/readme_excerpts_test.dart deleted file mode 100644 index bb85447dcc4..00000000000 --- a/packages/css_colors/example/test/readme_excerpts_test.dart +++ /dev/null @@ -1,23 +0,0 @@ -// Copyright 2013 The Flutter Authors. All rights reserved. -// Use of this source code is governed by a BSD-style license that can be -// found in the LICENSE file. - -import 'package:css_colors/css_colors.dart'; -import 'package:css_colors_example/readme_excerpts.dart'; -import 'package:flutter/material.dart'; -import 'package:flutter_test/flutter_test.dart'; - -void main() { - testWidgets('Container uses CSSColors.orange', (WidgetTester tester) async { - // Build the container and trigger a frame. - await tester.pumpWidget(MaterialApp(home: Scaffold(body: useCSSColors()))); - - // Verify that the Container has the correct color. - expect( - find.byWidgetPredicate( - (Widget widget) => - widget is Container && widget.color == CSSColors.orange, - ), - findsOneWidget); - }); -} diff --git a/packages/css_colors/pubspec.yaml b/packages/css_colors/pubspec.yaml index f39cb0ac556..b999cfe3f29 100644 --- a/packages/css_colors/pubspec.yaml +++ b/packages/css_colors/pubspec.yaml @@ -11,6 +11,8 @@ environment: dependencies: flutter: sdk: flutter + flutter_test: + sdk: flutter topics: - color diff --git a/packages/css_colors/test/css_colors_test.dart b/packages/css_colors/test/css_colors_test.dart new file mode 100644 index 00000000000..fd4de8d5138 --- /dev/null +++ b/packages/css_colors/test/css_colors_test.dart @@ -0,0 +1,22 @@ +// Copyright 2013 The Flutter Authors. All rights reserved. +// Use of this source code is governed by a BSD-style license that can be +// found in the LICENSE file. + +// #docregion Import +import 'package:css_colors/css_colors.dart'; +// #enddocregion Import +import 'package:flutter/material.dart'; +import 'package:flutter_test/flutter_test.dart'; + +void main() { + testWidgets('CSSColors.orange should be correct', + (WidgetTester tester) async { + // Create a Container widget using CSSColors.orange. + // #docregion Usage + final Container orange = Container(color: CSSColors.orange); + // #enddocregion Usage + + // Ensure the color of the container is the expected one. + expect(orange.color, equals(const Color(0xFFFFA500))); + }); +} From 815db67474755ffc15ab32fabbfc2d5123d24ca4 Mon Sep 17 00:00:00 2001 From: Mike Date: Tue, 12 Dec 2023 15:49:40 -0800 Subject: [PATCH 5/5] Remove 'Import' section --- packages/css_colors/README.md | 8 -------- packages/css_colors/test/css_colors_test.dart | 2 -- 2 files changed, 10 deletions(-) diff --git a/packages/css_colors/README.md b/packages/css_colors/README.md index 2a145141498..fba6306e331 100644 --- a/packages/css_colors/README.md +++ b/packages/css_colors/README.md @@ -5,14 +5,6 @@ This package defines color constants for the CSS colors. These color constants use the [Color](https://api.flutter.dev/flutter/dart-ui/Color-class.html) class from `dart:ui`, which means they're useful for Flutter apps. -Import ------- - - -```dart -import 'package:css_colors/css_colors.dart'; -``` - Use --- diff --git a/packages/css_colors/test/css_colors_test.dart b/packages/css_colors/test/css_colors_test.dart index fd4de8d5138..024e17e261f 100644 --- a/packages/css_colors/test/css_colors_test.dart +++ b/packages/css_colors/test/css_colors_test.dart @@ -2,9 +2,7 @@ // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. -// #docregion Import import 'package:css_colors/css_colors.dart'; -// #enddocregion Import import 'package:flutter/material.dart'; import 'package:flutter_test/flutter_test.dart';