From 76c77b1f6d8bda56ba14a1f519857e425368d12f Mon Sep 17 00:00:00 2001 From: Sergey Penkovsky Date: Wed, 16 Jul 2025 18:05:48 +0300 Subject: [PATCH] feat(cli): pretty build.yaml generation, full English docs, robust init command\n\n- build.yaml is always formatted\n- CLI help and output in English\n- README with usage and examples\n- Custom output dir and build.yaml supported\n- Safe update of existing configs\n- json2yaml for pretty YAML output --- cherrypick_cli/LICENSE | 201 ++++++++++++++++++ cherrypick_cli/README.md | 93 ++++++++ cherrypick_cli/bin/cherrypick_cli.dart | 8 + .../lib/src/commands/init_command.dart | 34 +++ .../lib/src/utils/build_yaml_updater.dart | 76 +++++++ cherrypick_cli/pubspec.lock | 85 ++++++++ cherrypick_cli/pubspec.yaml | 13 ++ 7 files changed, 510 insertions(+) create mode 100644 cherrypick_cli/LICENSE create mode 100644 cherrypick_cli/README.md create mode 100644 cherrypick_cli/bin/cherrypick_cli.dart create mode 100644 cherrypick_cli/lib/src/commands/init_command.dart create mode 100644 cherrypick_cli/lib/src/utils/build_yaml_updater.dart create mode 100644 cherrypick_cli/pubspec.lock create mode 100644 cherrypick_cli/pubspec.yaml diff --git a/cherrypick_cli/LICENSE b/cherrypick_cli/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/cherrypick_cli/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/cherrypick_cli/README.md b/cherrypick_cli/README.md new file mode 100644 index 0000000..3be8071 --- /dev/null +++ b/cherrypick_cli/README.md @@ -0,0 +1,93 @@ +# CherryPick CLI + +A command-line tool for managing and generating `build.yaml` configuration for the [CherryPick](https://github.com/pese-git/cherrypick) dependency injection ecosystem for Dart & Flutter. + +--- + +## Features +- 📦 Quickly add or update CherryPick generator sections in your project's `build.yaml`. +- 🛡️ Safely preserves unrelated configs and packages. +- 📝 Always outputs a human-friendly, formatted YAML file. +- 🏷️ Supports custom output directories and custom build.yaml file paths. + +--- + +## Getting Started + +1. **Navigate to the CLI package directory:** + ```bash + cd cherrypick_cli + ``` +2. **Get dependencies:** + ```bash + dart pub get + ``` +3. **Run the CLI:** + ```bash + dart run cherrypick_cli init --output_dir=lib/generated + ``` + +--- + +## Usage + +### Show help +```bash +dart run cherrypick_cli --help +``` + +### Add or update CherryPick sections in build.yaml +```bash +dart run cherrypick_cli init --output_dir=lib/generated +``` + +#### Options: +- `--output_dir`, `-o` — Directory for generated code (default: `lib/generated`) +- `--build_yaml`, `-f` — Path to build.yaml file (default: `build.yaml`) + +#### Example with custom build.yaml +```bash +dart run cherrypick_cli init --output_dir=custom/dir --build_yaml=custom_build.yaml +``` + +--- + +## What does it do? +- Adds or updates the following sections in your `build.yaml` (or custom file): + - `cherrypick_generator|inject_generator` + - `cherrypick_generator|module_generator` +- Ensures all YAML is pretty-printed and readable. +- Leaves unrelated configs untouched. + +--- + +## Example Output +```yaml +targets: + $default: + builders: + cherrypick_generator|inject_generator: + options: + build_extensions: + ^lib/{{}}.dart: + - lib/generated/{{}}.inject.cherrypick.g.dart + output_dir: lib/generated + generate_for: + - lib/**.dart + cherrypick_generator|module_generator: + options: + build_extensions: + ^lib/di/{{}}.dart: + - lib/generated/di/{{}}.module.cherrypick.g.dart + output_dir: lib/generated + generate_for: + - lib/**.dart +``` + +--- + +## Contributing +Pull requests and issues are welcome! See the [main CherryPick repo](https://github.com/pese-git/cherrypick) for more. + +## License +See [LICENSE](LICENSE). diff --git a/cherrypick_cli/bin/cherrypick_cli.dart b/cherrypick_cli/bin/cherrypick_cli.dart new file mode 100644 index 0000000..13450cf --- /dev/null +++ b/cherrypick_cli/bin/cherrypick_cli.dart @@ -0,0 +1,8 @@ +import 'package:args/command_runner.dart'; +import 'package:cherrypick_cli/src/commands/init_command.dart'; + +void main(List args) { + final runner = CommandRunner('cherrypick_cli', 'CherryPick CLI') + ..addCommand(InitCommand()); + runner.run(args); +} diff --git a/cherrypick_cli/lib/src/commands/init_command.dart b/cherrypick_cli/lib/src/commands/init_command.dart new file mode 100644 index 0000000..9b10daf --- /dev/null +++ b/cherrypick_cli/lib/src/commands/init_command.dart @@ -0,0 +1,34 @@ +import 'package:args/command_runner.dart'; +import '../utils/build_yaml_updater.dart'; + +class InitCommand extends Command { + @override + final name = 'init'; + @override + final description = 'Adds or updates cherrypick_generator sections in build.yaml, preserving other packages.'; + + InitCommand() { + argParser.addOption( + 'output_dir', + abbr: 'o', + defaultsTo: 'lib/generated', + help: 'Directory for generated code.', + ); + argParser.addOption( + 'build_yaml', + abbr: 'f', + defaultsTo: 'build.yaml', + help: 'Path to build.yaml file.', + ); + } + + @override + void run() { + final outputDir = argResults?['output_dir'] as String? ?? 'lib/generated'; + final buildYaml = argResults?['build_yaml'] as String? ?? 'build.yaml'; + updateCherrypickBuildYaml( + buildYamlPath: buildYaml, + outputDir: outputDir, + ); + } +} diff --git a/cherrypick_cli/lib/src/utils/build_yaml_updater.dart b/cherrypick_cli/lib/src/utils/build_yaml_updater.dart new file mode 100644 index 0000000..cc73c52 --- /dev/null +++ b/cherrypick_cli/lib/src/utils/build_yaml_updater.dart @@ -0,0 +1,76 @@ +import 'dart:io'; +import 'package:yaml/yaml.dart'; +import 'package:json2yaml/json2yaml.dart'; + +void updateCherrypickBuildYaml({ + String buildYamlPath = 'build.yaml', + String outputDir = 'lib/generated', +}) { + final file = File(buildYamlPath); + final exists = file.existsSync(); + Map config = {}; + if (exists) { + final content = file.readAsStringSync(); + final loaded = loadYaml(content); + config = _deepYamlToMap(loaded); + } + + // Гарантируем вложенность + config['targets'] ??= {}; + final targets = config['targets'] as Map; + targets['\$default'] ??= {}; + final def = targets['\$default'] as Map; + def['builders'] ??= {}; + final builders = def['builders'] as Map; + + builders['cherrypick_generator|inject_generator'] = { + 'options': { + 'build_extensions': { + '^lib/{{}}.dart': ['${outputDir}/{{}}.inject.cherrypick.g.dart'] + }, + 'output_dir': outputDir + }, + 'generate_for': ['lib/**.dart'] + }; + + builders['cherrypick_generator|module_generator'] = { + 'options': { + 'build_extensions': { + '^lib/di/{{}}.dart': ['${outputDir}/di/{{}}.module.cherrypick.g.dart'] + }, + 'output_dir': outputDir + }, + 'generate_for': ['lib/**.dart'] + }; + + final yamlString = json2yaml(_stringifyKeys(config), yamlStyle: YamlStyle.pubspecYaml); + file.writeAsStringSync(yamlString); + print('✅ build.yaml has been successfully updated and formatted (cherrypick sections added/updated).'); +} + +dynamic _stringifyKeys(dynamic node) { + if (node is Map) { + return Map.fromEntries( + node.entries.map( + (e) => MapEntry(e.key.toString(), _stringifyKeys(e.value)), + ), + ); + } else if (node is List) { + return node.map(_stringifyKeys).toList(); + } else { + return node; + } +} + + +/// Рекурсивно преобразует YamlMap/YamlList в обычные Map/List +dynamic _deepYamlToMap(dynamic node) { + if (node is YamlMap) { + return Map.fromEntries(node.entries.map((e) => MapEntry(e.key, _deepYamlToMap(e.value)))); + } else if (node is YamlList) { + return node.map(_deepYamlToMap).toList(); + } else { + return node; + } +} + diff --git a/cherrypick_cli/pubspec.lock b/cherrypick_cli/pubspec.lock new file mode 100644 index 0000000..d88368a --- /dev/null +++ b/cherrypick_cli/pubspec.lock @@ -0,0 +1,85 @@ +# Generated by pub +# See https://dart.dev/tools/pub/glossary#lockfile +packages: + args: + dependency: "direct main" + description: + name: args + sha256: d0481093c50b1da8910eb0bb301626d4d8eb7284aa739614d2b394ee09e3ea04 + url: "https://pub.dev" + source: hosted + version: "2.7.0" + collection: + dependency: transitive + description: + name: collection + sha256: "2f5709ae4d3d59dd8f7cd309b4e023046b57d8a6c82130785d2b0e5868084e76" + url: "https://pub.dev" + source: hosted + version: "1.19.1" + json2yaml: + dependency: "direct main" + description: + name: json2yaml + sha256: da94630fbc56079426fdd167ae58373286f603371075b69bf46d848d63ba3e51 + url: "https://pub.dev" + source: hosted + version: "3.0.1" + meta: + dependency: transitive + description: + name: meta + sha256: "23f08335362185a5ea2ad3a4e597f1375e78bce8a040df5c600c8d3552ef2394" + url: "https://pub.dev" + source: hosted + version: "1.17.0" + path: + dependency: transitive + description: + name: path + sha256: "75cca69d1490965be98c73ceaea117e8a04dd21217b37b292c9ddbec0d955bc5" + url: "https://pub.dev" + source: hosted + version: "1.9.1" + source_span: + dependency: transitive + description: + name: source_span + sha256: "254ee5351d6cb365c859e20ee823c3bb479bf4a293c22d17a9f1bf144ce86f7c" + url: "https://pub.dev" + source: hosted + version: "1.10.1" + string_scanner: + dependency: transitive + description: + name: string_scanner + sha256: "921cd31725b72fe181906c6a94d987c78e3b98c2e205b397ea399d4054872b43" + url: "https://pub.dev" + source: hosted + version: "1.4.1" + term_glyph: + dependency: transitive + description: + name: term_glyph + sha256: "7f554798625ea768a7518313e58f83891c7f5024f88e46e7182a4558850a4b8e" + url: "https://pub.dev" + source: hosted + version: "1.2.2" + yaml: + dependency: "direct main" + description: + name: yaml + sha256: b9da305ac7c39faa3f030eccd175340f968459dae4af175130b3fc47e40d76ce + url: "https://pub.dev" + source: hosted + version: "3.1.3" + yaml_edit: + dependency: "direct main" + description: + name: yaml_edit + sha256: fb38626579fb345ad00e674e2af3a5c9b0cc4b9bfb8fd7f7ff322c7c9e62aef5 + url: "https://pub.dev" + source: hosted + version: "2.2.2" +sdks: + dart: ">=3.5.0 <4.0.0" diff --git a/cherrypick_cli/pubspec.yaml b/cherrypick_cli/pubspec.yaml new file mode 100644 index 0000000..0d355ba --- /dev/null +++ b/cherrypick_cli/pubspec.yaml @@ -0,0 +1,13 @@ +name: cherrypick_cli +version: 0.1.0 +publish_to: none +description: CLI tool for CherryPick DI ecosystem +environment: + sdk: ">=3.0.0 <4.0.0" +dependencies: + args: ^2.4.2 + yaml: ^3.1.2 + yaml_edit: ^2.1.1 + json2yaml: ^3.0.0 +executables: + cherrypick_cli: