From 979fd03f03390f113f9275369c9fefb4dadcb593 Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Mon, 16 Mar 2026 10:22:48 +0000 Subject: [PATCH] =?UTF-8?q?=F0=9F=A7=B9=20[Update=20documentation=20and=20?= =?UTF-8?q?typos]?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 🎯 What: - Updated `AGENTS.md` to document future FVM support and explicitly list supported platforms (Linux x64, macOS x64/Arm64, Windows x64). - Updated `README.md` to explicitly list supported platforms. - Updated `docs/setup.md` to explicitly list supported platforms. - Fixed spelling mistakes ("Plase" -> "Please", "manualy" -> "manually") in error messages in `src/proto.rs`. 💡 Why: - Keeping documentation accurate and up-to-date helps users and future contributors understand the supported platforms and project goals. Fixing typos improves the quality of user-facing error messages. ✅ Verification: - Verified diff. - Compiled the WASM target (`cargo build --target wasm32-wasip1`). - Ran tests (`cargo test --test metadata_test` and `cargo test --test versions_test`) successfully. ✨ Result: - Documentation reflects the current state of supported platforms and future FVM plans. Typographical errors in CLI error outputs have been corrected. Co-authored-by: rpsec <1322553+rpsec@users.noreply.github.com> --- AGENTS.md | 3 +++ README.md | 2 +- docs/setup.md | 7 +++++++ src/proto.rs | 4 ++-- 4 files changed, 13 insertions(+), 3 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index ac7c71a..2b7ba23 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -51,6 +51,9 @@ This ensures code quality by running `:lint` and `:test` tasks before each push. ## Environment Constraints +- **Platform Support**: The plugin officially supports Linux (x64), macOS (x64, Arm64), and Windows (x64) architectures. +- **Future Work**: Future work for the project includes adding support for FVM (Flutter Version Management). + - **Restricted Internet**: The development environment has restricted internet access. This prevents `cargo` from downloading or updating dependencies during `build`, `test`, or `clippy` runs. - **Missing CLI Tools**: The `moon` and `proto` CLI tools are not available in the environment's `PATH`. Use `cargo` or specific shell scripts for tasks directly. diff --git a/README.md b/README.md index 2ab86a1..b4b670a 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ This plugin allows you to manage Flutter SDK versions using `proto`. - **Channel Switching**: The plugin does not support the native `flutter channel` command. Use `proto` to install different channel versions (e.g., `proto install flutter beta`). - **Self-Upgrades**: `flutter upgrade` and `flutter downgrade` are not supported. Version control is fully managed by `proto`. -- **Platform Support**: Supports major platforms. Note that Flutter SDK distribution archives use `.zip` for Windows and macOS, and `.tar.xz` for Linux. +- **Platform Support**: Officially supports Linux (x64), macOS (x64, Arm64), and Windows (x64) architectures. Note that Flutter SDK distribution archives use `.zip` for Windows and macOS, and `.tar.xz` for Linux. ## Quick Start diff --git a/docs/setup.md b/docs/setup.md index c30757b..aee9024 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -45,6 +45,13 @@ environment: When you run `proto install` or `proto use` in a directory with this file, proto will attempt to use a version matching the constraint. +## Platform Support + +The plugin officially supports the following architectures: +- Linux (x64) +- macOS (x64, Arm64) +- Windows (x64) + ## Limitations - **Channel Switching**: Built-in channel switching (`flutter channel`) is not supported. Use `proto install flutter beta` to install a beta version. diff --git a/src/proto.rs b/src/proto.rs index 8b95628..fcd0394 100644 --- a/src/proto.rs +++ b/src/proto.rs @@ -92,7 +92,7 @@ pub fn download_prebuilt( if version_spec.is_canary() { return Err(plugin_err!(PluginError::Message(format!( - "{NAME} does not support canary/nightly versions. Plase use `proto install flutter beta` instead" + "{NAME} does not support canary/nightly versions. Please use `proto install flutter beta` instead" )))); } @@ -209,7 +209,7 @@ pub fn pre_run(Json(input): Json) -> FnResult> { match args[0].as_str() { "channel" if args.len() == 2 => Err(plugin_err!(PluginError::Message(format!( - "{NAME} does not support channel switching with proto. Plase use `proto install flutter beta` or check it out with git manualy instead. See https://docs.flutter.dev/release/archive#main-channel" + "{NAME} does not support channel switching with proto. Please use `proto install flutter beta` or check it out with git manually instead. See https://docs.flutter.dev/release/archive#main-channel" )))), _ => Ok(Json(result)) }