Skip to content

DartBuild/cocoapods-embed-flutter

Repository files navigation

CocoaPods Embed Flutter

CI/CD Gem Version Maintainability CodeQL

Straight forward way of declaring flutter modules as dependency for targets, just like cocoapods does with pods.

Installation

Install using command line.

$ [sudo] gem install cocoapods-embed-flutter

Or add this to your Gemfile.

gem 'cocoapods-embed-flutter'

Usage

In your host project Podfile, write the below line before any target definition

plugin 'cocoapods-embed-flutter'

Embedding module from a local path.

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.

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 restictions.

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 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 Official Ruby Gems page.
Code docs Generated code documentation.
Changelog See the changes introduced in each version.
Code of Conduct Find out the standards we hold ourselves to.