Skip to content

🧹 Update documentation and fix typos #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rpsec wants to merge 1 commit into
base: main
Choose a base branch
from
Open

🧹 Update documentation and fix typos #16

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
7 changes: 7 additions & 0 deletions docs/setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions src/proto.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
))));
}

Expand Down Expand Up @@ -209,7 +209,7 @@ pub fn pre_run(Json(input): Json<RunHook>) -> FnResult<Json<RunHookResult>> {

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))
}
Expand Down