From abbaf4b8064d27f1adaec426afca02a7569aee82 Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Mon, 23 Feb 2026 11:13:47 +0000 Subject: [PATCH] Update documentation for accuracy and consistency - Updated `docs/setup.md` to use the correct repository URL `github://rpsec/proto-flutter-plugin`. - Enhanced `AGENTS.md` with a "Development Workflow" section detailing `moon` tasks and a "Future Work" section referencing the FVM support TODO. - Updated `README.md` to mention that the plugin also provides the `dart` executable. Co-authored-by: rpsec <1322553+rpsec@users.noreply.github.com> --- AGENTS.md | 22 +++++++++++++--------- README.md | 2 ++ docs/setup.md | 4 ++-- 3 files changed, 17 insertions(+), 11 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index c031c3c..747ee16 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -23,18 +23,18 @@ The project compiles to WASM using `cargo`. The `build-wasm.sh` script performs The script **hardcodes** these tool paths to `~/Dev/web-assembly-binaryen/bin/` and `~/Dev/web-assembly-wabt/bin/`. If you are asked to fix build issues related to these tools, checking/updating these paths in `build-wasm.sh` is a primary step. -### moon Tasks +## Development Workflow This repository is set up as a moon repository with the following tasks: -- `moon run :format` - Format code using cargo fmt -- `moon run :format-check` - Check code formatting -- `moon run :lint` - Lint code using cargo clippy -- `moon run :build` - Build the project for development -- `moon run :build-wasm` - Build the WASM plugin (requires wasm32-wasip1 target) -- `moon run :test` - Run all tests -- `moon run :check` - Run format-check, lint, and test -- `moon run :clean` - Clean build artifacts +- `moon run :format` - Format code using cargo fmt. +- `moon run :format-check` - Check code formatting. +- `moon run :lint` - Lint code using cargo clippy. +- `moon run :build` - Build the project for development. +- `moon run :build-wasm` - Build the WASM plugin (requires `wasm32-wasip1` target). +- `moon run :test` - Run all tests. +- `moon run :check` - Run format-check, lint, and test. +- `moon run :clean` - Clean build artifacts. ### proto Integration @@ -62,3 +62,7 @@ Integration tests using `proto_pdk_test_utils` often require a mock proto enviro - Follow standard Rust formatting (`cargo fmt` or `moon run :format`). - Ensure `cargo clippy` passes (`moon run :lint`). + +## Future Work + +- **FVM Support**: There is a TODO in `src/proto.rs` to add support for FVM (Flutter Version Management) configuration files. diff --git a/README.md b/README.md index e319bde..835943e 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,7 @@ This plugin allows you to manage Flutter SDK versions using `proto`. - **Aliases**: Supports `stable`, `beta`, and `latest` aliases. - **Version Detection**: Detects required Flutter version from `pubspec.yaml`. - **Pre-built Binaries**: Downloads pre-built Flutter SDKs from Google's infrastructure (or a configured mirror). +- **Executables**: Provides both `flutter` and `dart` commands. ### Limitations @@ -43,6 +44,7 @@ This plugin allows you to manage Flutter SDK versions using `proto`. 3. **Use Flutter**: ```sh flutter --version + dart --version ``` ## Development diff --git a/docs/setup.md b/docs/setup.md index 6b9c4cd..c30757b 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -6,13 +6,13 @@ Add the plugin to your `.prototools` file: ```toml [plugins] -flutter = "github://KonstantinKai/proto-flutter-plugin" +flutter = "github://rpsec/proto-flutter-plugin" ``` Or install via command line: ```sh -proto plugin add flutter github://KonstantinKai/proto-flutter-plugin +proto plugin add flutter github://rpsec/proto-flutter-plugin ``` ## Configuration