mapbox / mapbox/mapbox-maps-flutter
[CONTRIBUTING] How to use pigeon to generate native code wrappers
Nobody has claimed this yet.
- Dominant language
- Dart
- Stars
- 380
- Forks
- 204
- PR merge metrics
- No merged PRs in 30d
Description
I want to contribute by adding / exposing some additional functionality, already present in the native SDK but not exposed by the flutter wrapper.
Looking at the project, I understand that platform channel communication is done via pigeon. But I don't know how to generate the code (from .dart files or maybe .orig files?) to expose native functionality.
Please provide some documentation (or maybe just point me in the right direction here and I'll add the docs myself) on how to use pigeon, which files to use for the interface and which paths to use.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the Pigeon interface files and any .dart or .orig files used by the Flutter wrapper. Trace how native code is generated and where the generated files are written. Done means documenting the required interface files, generation command, and output paths so contributors can expose existing native SDK functionality.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- dart, flutter
- Domain
- documentation, mobile-dev
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100