From c2aa9ce7788eed483806aa700935893f7b9a88c6 Mon Sep 17 00:00:00 2001 From: Ellet Date: Wed, 2 Oct 2024 12:37:56 +0300 Subject: [PATCH 1/7] [pigeon] chore(readme): deprecated command of running pigeon --- packages/pigeon/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/pigeon/README.md b/packages/pigeon/README.md index a3c4f341ade7..cc375f5e2faa 100644 --- a/packages/pigeon/README.md +++ b/packages/pigeon/README.md @@ -86,7 +86,7 @@ to the api to allow for multiple instances to be created and operate in parallel 1) Make a ".dart" file outside of your "lib" directory for defining the communication interface. 1) Run pigeon on your ".dart" file to generate the required Dart and - host-language code: `flutter pub get` then `flutter pub run pigeon` + host-language code: `flutter pub get` then `dart run pigeon` with suitable arguments. [Example](./example/README.md#Invocation). 1) Add the generated Dart code to `./lib` for compilation. 1) Implement the host-language code and add it to your build (see below). From 753506864565bb46fe077f44062db0595647f930 Mon Sep 17 00:00:00 2001 From: Ellet Date: Wed, 2 Oct 2024 15:21:31 +0300 Subject: [PATCH 2/7] chore(version): update version to 22.4.2, add CHANGELOG entry --- packages/pigeon/CHANGELOG.md | 4 ++++ packages/pigeon/lib/generator_tools.dart | 2 +- packages/pigeon/pubspec.yaml | 2 +- 3 files changed, 6 insertions(+), 2 deletions(-) diff --git a/packages/pigeon/CHANGELOG.md b/packages/pigeon/CHANGELOG.md index d94d1ab79ca8..89f924967e09 100644 --- a/packages/pigeon/CHANGELOG.md +++ b/packages/pigeon/CHANGELOG.md @@ -1,3 +1,7 @@ +## 22.4.2 + +* Update outdated command of running pigeon in README.md + ## 22.4.1 * [dart] Fixes bug where special handling of ints is ignored if no custom types are used. diff --git a/packages/pigeon/lib/generator_tools.dart b/packages/pigeon/lib/generator_tools.dart index b5029a68aaae..ef623942f4f2 100644 --- a/packages/pigeon/lib/generator_tools.dart +++ b/packages/pigeon/lib/generator_tools.dart @@ -14,7 +14,7 @@ import 'ast.dart'; /// The current version of pigeon. /// /// This must match the version in pubspec.yaml. -const String pigeonVersion = '22.4.1'; +const String pigeonVersion = '22.4.2'; /// Read all the content from [stdin] to a String. String readStdin() { diff --git a/packages/pigeon/pubspec.yaml b/packages/pigeon/pubspec.yaml index fef6a7c6fff1..2dae3a41b7d8 100644 --- a/packages/pigeon/pubspec.yaml +++ b/packages/pigeon/pubspec.yaml @@ -2,7 +2,7 @@ name: pigeon description: Code generator tool to make communication between Flutter and the host platform type-safe and easier. repository: https://github.com/flutter/packages/tree/main/packages/pigeon issue_tracker: https://github.com/flutter/flutter/issues?q=is%3Aissue+is%3Aopen+label%3A%22p%3A+pigeon%22 -version: 22.4.1 # This must match the version in lib/generator_tools.dart +version: 22.4.2 # This must match the version in lib/generator_tools.dart environment: sdk: ^3.3.0 From 340e1965f725e9c24481e777bbdd2fc36103c000 Mon Sep 17 00:00:00 2001 From: Ellet Date: Wed, 2 Oct 2024 15:24:22 +0300 Subject: [PATCH 3/7] chore: update CHANGELOG.md entry item for clarity --- packages/pigeon/CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/pigeon/CHANGELOG.md b/packages/pigeon/CHANGELOG.md index 89f924967e09..3de77e230553 100644 --- a/packages/pigeon/CHANGELOG.md +++ b/packages/pigeon/CHANGELOG.md @@ -1,6 +1,6 @@ ## 22.4.2 -* Update outdated command of running pigeon in README.md +* Update README.md to use `dart run pigeon` instead of the deprecated command `flutter pub run pigeon`. ## 22.4.1 From 14d8239b0bcb09c846533899daf26ce651d51fa5 Mon Sep 17 00:00:00 2001 From: Ellet Date: Wed, 2 Oct 2024 15:36:58 +0300 Subject: [PATCH 4/7] test(readme): add minimal test to ensure not to use deprecated command to run pigeon --- packages/pigeon/test/readme_test.dart | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 packages/pigeon/test/readme_test.dart diff --git a/packages/pigeon/test/readme_test.dart b/packages/pigeon/test/readme_test.dart new file mode 100644 index 000000000000..5f9412c9c40f --- /dev/null +++ b/packages/pigeon/test/readme_test.dart @@ -0,0 +1,21 @@ +// 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 'dart:io'; + +import 'package:test/test.dart'; + +void main() { + final File readmeFile = File('README.md'); + final String readmeText = readmeFile.readAsStringSync(); + + group('README.md', () { + test('does not include deprecated command for running pigeon', () { + expect(readmeText, isNot(contains('flutter pub run pigeon'))); + }); + test('includes the current command for running pigeon', () { + expect(readmeText, contains('dart run pigeon')); + }); + }); +} From fd1d9467e7712cbd229d8f0f672022d1245cb7ed Mon Sep 17 00:00:00 2001 From: Ellet Date: Wed, 2 Oct 2024 18:18:40 +0300 Subject: [PATCH 5/7] chore(test): remove unnecessary README test --- packages/pigeon/test/readme_test.dart | 21 --------------------- 1 file changed, 21 deletions(-) delete mode 100644 packages/pigeon/test/readme_test.dart diff --git a/packages/pigeon/test/readme_test.dart b/packages/pigeon/test/readme_test.dart deleted file mode 100644 index 5f9412c9c40f..000000000000 --- a/packages/pigeon/test/readme_test.dart +++ /dev/null @@ -1,21 +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 'dart:io'; - -import 'package:test/test.dart'; - -void main() { - final File readmeFile = File('README.md'); - final String readmeText = readmeFile.readAsStringSync(); - - group('README.md', () { - test('does not include deprecated command for running pigeon', () { - expect(readmeText, isNot(contains('flutter pub run pigeon'))); - }); - test('includes the current command for running pigeon', () { - expect(readmeText, contains('dart run pigeon')); - }); - }); -} From b69923a4f723c830beffa8455121c56bbaf9ff62 Mon Sep 17 00:00:00 2001 From: Ellet Date: Thu, 3 Oct 2024 00:18:00 +0300 Subject: [PATCH 6/7] chore(readme): update CHANGELOG.md entry for consistency --- packages/pigeon/CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/pigeon/CHANGELOG.md b/packages/pigeon/CHANGELOG.md index 3de77e230553..6142ec4a5073 100644 --- a/packages/pigeon/CHANGELOG.md +++ b/packages/pigeon/CHANGELOG.md @@ -1,6 +1,6 @@ ## 22.4.2 -* Update README.md to use `dart run pigeon` instead of the deprecated command `flutter pub run pigeon`. +* Changes `README.md` to replace the deprecated `flutter pub run pigeon` command with `dart run pigeon`. ## 22.4.1 From 23f52bf93aeafb14d416268d7d910bf2df5f1eef Mon Sep 17 00:00:00 2001 From: Ellet Date: Thu, 3 Oct 2024 00:22:54 +0300 Subject: [PATCH 7/7] chore(changelog): use 'Updates' instead of 'Changes' --- packages/pigeon/CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/pigeon/CHANGELOG.md b/packages/pigeon/CHANGELOG.md index 6142ec4a5073..366e387ce00b 100644 --- a/packages/pigeon/CHANGELOG.md +++ b/packages/pigeon/CHANGELOG.md @@ -1,6 +1,6 @@ ## 22.4.2 -* Changes `README.md` to replace the deprecated `flutter pub run pigeon` command with `dart run pigeon`. +* Updates `README.md` to replace the deprecated `flutter pub run pigeon` command with `dart run pigeon`. ## 22.4.1