Skip to content

Update documentation for accuracy and consistency #13

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 for accuracy and consistency #13

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
22 changes: 13 additions & 9 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

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

Expand All @@ -43,6 +44,7 @@ This plugin allows you to manage Flutter SDK versions using `proto`.
3. **Use Flutter**:
```sh
flutter --version
dart --version
```

## Development
Expand Down
4 changes: 2 additions & 2 deletions docs/setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down