Add AGENTS.md for Cursor Cloud development environment setup#74
Conversation
Co-authored-by: Arhan Choudhury <Arhan13@users.noreply.github.com>
📝 WalkthroughWalkthroughA new documentation file AGENTS.md is added, describing the Helium Flutter SDK integration for Cursor Cloud. It covers prerequisites, quick reference tasks with Flutter commands, working directories, and important gotchas including root workspace behavior, environment file requirements, iOS build limitations, and Android SDK handling. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@AGENTS.md`:
- Line 18: The table row for "Analyze all" is missing the third column and
breaks the 3-column table; update the row in AGENTS.md (the line containing
"Analyze all | Run `flutter analyze` in each package directory") to include a
third cell for the "Working directory" column (for example "each package
directory" or "repo root"), ensuring the row has three pipe-separated cells to
match the table header.
- Line 5: The heading "Cursor Cloud specific instructions" should use a hyphen
for the compound adjective; update the text to read "Cursor Cloud-specific
instructions" wherever the heading or this phrase appears (e.g., the AGENTS.md
heading string) to correct grammar and maintain consistency.
- Line 26: Update the sentence that currently reads "**No iOS builds on Linux**:
iOS plugin builds and `helium_stripe` (iOS-only) cannot compile on Linux VMs.
Analysis and Dart unit tests still work." to accurately describe `helium_stripe`
as a mobile-only SDK supporting both iOS and Android: state that iOS plugin
builds cannot be performed on Linux VMs while clarifying that `helium_stripe`
supports Android as well (i.e., is not iOS-only) and keep the note that analysis
and Dart unit tests still work; reference the occurrence of the phrase "No iOS
builds on Linux" and the `helium_stripe` mention when making the edit.
|
|
||
| Flutter plugin wrapping native iOS (Swift) and Android (Kotlin) Helium SDKs. See `CLAUDE.md` for architecture and key principles, `CONTRIBUTING.md` for release/CI workflows. | ||
|
|
||
| ## Cursor Cloud specific instructions |
There was a problem hiding this comment.
Add hyphen to compound adjective.
The phrase "Cursor Cloud specific instructions" should be "Cursor Cloud-specific instructions" when used as a compound adjective modifying a noun.
📝 Proposed fix
-## Cursor Cloud specific instructions
+## Cursor Cloud-specific instructions📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## Cursor Cloud specific instructions | |
| ## Cursor Cloud-specific instructions |
🧰 Tools
🪛 LanguageTool
[grammar] ~5-~5: Use a hyphen to join words.
Context: ...r release/CI workflows. ## Cursor Cloud specific instructions ### Prerequisites...
(QB_NEW_EN_HYPHEN)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@AGENTS.md` at line 5, The heading "Cursor Cloud specific instructions" should
use a hyphen for the compound adjective; update the text to read "Cursor
Cloud-specific instructions" wherever the heading or this phrase appears (e.g.,
the AGENTS.md heading string) to correct grammar and maintain consistency.
| | Install deps | `flutter pub get` | `/workspace` (root) | | ||
| | Analyze a package | `flutter analyze` | `packages/helium_flutter`, `packages/helium_revenuecat`, or `packages/helium_stripe` | | ||
| | Run tests | `flutter test` | Same as above | | ||
| | Analyze all | Run `flutter analyze` in each package directory | |
There was a problem hiding this comment.
Fix table column count.
This table row has only 2 cells but the table defines 3 columns (Task, Command, Working directory). The third column is missing, which breaks the table structure.
📋 Proposed fix
-| Analyze all | Run `flutter analyze` in each package directory |
+| Analyze all | Run `flutter analyze` in each package directory | N/A |Or, if you want to be more specific:
-| Analyze all | Run `flutter analyze` in each package directory |
+| Analyze all | `flutter analyze` | Each package directory |📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| | Analyze all | Run `flutter analyze` in each package directory | | |
| | Analyze all | `flutter analyze` | Each package directory | |
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 18-18: Table column count
Expected: 3; Actual: 2; Too few cells, row will be missing data
(MD056, table-column-count)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@AGENTS.md` at line 18, The table row for "Analyze all" is missing the third
column and breaks the 3-column table; update the row in AGENTS.md (the line
containing "Analyze all | Run `flutter analyze` in each package directory") to
include a third cell for the "Working directory" column (for example "each
package directory" or "repo root"), ensuring the row has three pipe-separated
cells to match the table header.
|
|
||
| - **Dart workspaces**: The root `pubspec.yaml` defines a workspace with all packages + example. A single `flutter pub get` at root resolves deps for everything — no need to run it per-package. | ||
| - **`.env` file required**: The example app expects `example/.env` (gitignored). Copy from `example/.env.example`. For CI/test purposes, empty string values are fine. | ||
| - **No iOS builds on Linux**: iOS plugin builds and `helium_stripe` (iOS-only) cannot compile on Linux VMs. Analysis and Dart unit tests still work. |
There was a problem hiding this comment.
Correct the platform support description for helium_stripe.
The description incorrectly states that helium_stripe is "iOS-only." The package actually supports both iOS and Android platforms. While iOS-specific components cannot build on Linux, the package itself is not limited to iOS.
Based on learnings, the helium_stripe package is strictly a mobile-only SDK supporting both iOS and Android.
📱 Proposed fix
-- **No iOS builds on Linux**: iOS plugin builds and `helium_stripe` (iOS-only) cannot compile on Linux VMs. Analysis and Dart unit tests still work.
+- **No iOS builds on Linux**: iOS plugin builds and the iOS components of `helium_stripe` cannot compile on Linux VMs. Analysis and Dart unit tests still work.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - **No iOS builds on Linux**: iOS plugin builds and `helium_stripe` (iOS-only) cannot compile on Linux VMs. Analysis and Dart unit tests still work. | |
| - **No iOS builds on Linux**: iOS plugin builds and the iOS components of `helium_stripe` cannot compile on Linux VMs. Analysis and Dart unit tests still work. |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@AGENTS.md` at line 26, Update the sentence that currently reads "**No iOS
builds on Linux**: iOS plugin builds and `helium_stripe` (iOS-only) cannot
compile on Linux VMs. Analysis and Dart unit tests still work." to accurately
describe `helium_stripe` as a mobile-only SDK supporting both iOS and Android:
state that iOS plugin builds cannot be performed on Linux VMs while clarifying
that `helium_stripe` supports Android as well (i.e., is not iOS-only) and keep
the note that analysis and Dart unit tests still work; reference the occurrence
of the phrase "No iOS builds on Linux" and the `helium_stripe` mention when
making the edit.
2 participants
Adds
AGENTS.mdwith Cursor Cloud specific development instructions for future cloud agents.What's included
.envfile requirement, no iOS on Linux, Android SDK auto-downloads, no backend services neededEnvironment verification
All the following were verified successfully during setup:
flutter analyze(helium_flutter)flutter analyze(helium_revenuecat)flutter analyze(helium_stripe)flutter test(helium_flutter)flutter test(helium_revenuecat)flutter test(helium_stripe)flutter pub publish --dry-runflutter build apk --debug(example)Summary by CodeRabbit
Documentation