https://github.com/dartbuild/cocoapods-embed-flutter
Cocoapods plugin to allow declaring flutter module as dependency
https://github.com/dartbuild/cocoapods-embed-flutter
cocoapods cocoapods-plugin flutter flutter-cocoapods flutter-embedder flutter-integrate flutter-ios flutter-module-native ios ios-flutter plugin
Last synced: 8 months ago
JSON representation
Cocoapods plugin to allow declaring flutter module as dependency
- Host: GitHub
- URL: https://github.com/dartbuild/cocoapods-embed-flutter
- Owner: DartBuild
- License: mit
- Created: 2022-03-06T14:40:40.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2023-09-01T07:52:40.000Z (almost 3 years ago)
- Last Synced: 2025-01-27T15:52:18.710Z (over 1 year ago)
- Topics: cocoapods, cocoapods-plugin, flutter, flutter-cocoapods, flutter-embedder, flutter-integrate, flutter-ios, flutter-module-native, ios, ios-flutter, plugin
- Language: Ruby
- Homepage: https://rubygems.org/gems/cocoapods-embed-flutter
- Size: 126 KB
- Stars: 17
- Watchers: 0
- Forks: 8
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# CocoaPods Embed Flutter
[](https://github.com/DartBuild/cocoapods-embed-flutter/actions/workflows/main.yml)
[](http://badge.fury.io/rb/cocoapods-embed-flutter)
[](https://codeclimate.com/github/DartBuild/cocoapods-embed-flutter/maintainability)
[](https://github.com/DartBuild/cocoapods-embed-flutter/actions/workflows/codeql-analysis.yml)
Straight forward way of declaring flutter modules as dependency for targets, just like cocoapods does with pods.
## Installation
### Install using command line.
```bash
$ [sudo] gem install cocoapods-embed-flutter
```
### Or add this to your `Gemfile`.
```rb
gem 'cocoapods-embed-flutter'
```
## Usage
In your host project `Podfile`, write the below line before any target definition
```rb
plugin 'cocoapods-embed-flutter'
```
### Embedding module from a local path.
```rb
pub 'flutter_module', :path => '../'
```
*`:path` can be path pointing to `pubspec.yaml` or to the directory containing `pubspec.yaml` or to the directory containg flutter module.*
### Embedding module from a repository.
```rb
pub 'flutter_module', :git => 'https://github.com/gowalla/flutter_module.git', :branch => 'dev'
pub 'flutter_module', :git => 'https://github.com/gowalla/flutter_module.git', :tag => '0.7.0'
pub 'flutter_module', :git => 'https://github.com/gowalla/flutter_module.git', :commit => '082f8319af'
```
*flutter module project should be at the root of repository, if that's not the case add additional `:path` attribute for relative path to flutter project in repository. `:path` follows [these](#path_desc) restictions.*
```rb
pub 'flutter_module', :git => 'https://github.com/gowalla/flutter_module.git', :tag => '0.7.0', :path => 'relative path/to/project'
```
## Limitations
- Modules hosted in [pub.dev](https://pub.dev/) are not supported, only local modules and modules in remote sources like git are supported.
- You won't be able to add more than one flutter module to a single target. Currently flutter only supports one module per target.
- No caching is done for external sources, every time you run `pod install` flutter module will be downloaded each time.
## Links
| Link | Description |
| :----- | :------ |
[Gem page](https://rubygems.org/gems/cocoapods-embed-flutter) | Official Ruby Gems page.
[Code docs](https://www.rubydoc.info/gems/cocoapods-embed-flutter) | Generated code documentation.
[Changelog](https://github.com/DartBuild/cocoapods-embed-flutter/blob/main/CHANGELOG.md) | See the changes introduced in each version.
[Code of Conduct](CODE_OF_CONDUCT.md) | Find out the standards we hold ourselves to.