A Very Good Flutter Federated Plugin created by the Very Good Ventures Team 🦄

Very Good Open Source

Last update: Oct 19, 2022

Overview

Very Good Flutter Plugin

Developed with 💙 by Very Good Ventures 🦄

A Very Good Flutter Plugin created by the Very Good Ventures Team.

Getting Started 🚀

❗ In order to start using Very Good Flutter Plugin you must have the Flutter SDK installed on your machine.

Running the Example ⚙️

The src directory contains the main my_plugin package along with the platform interface and the platform-specific implementations.

You can run the example via:

cd src/my_plugin/example
flutter run

The plugin supports the following platforms:

✅ Android
✅ iOS
✅ Linux
✅ MacOS
✅ Web
✅ Windows

Generating a Custom Plugin 📦

This repository powers the flutter_plugin template exposed via Very Good CLI.

If you have not previously installed Very Good CLI, you can install it via:

dart pub global activate very_good_cli

A custom plugin can be generated via the create command:

very_good create my_plugin -t flutter_plugin

A custom description and org name can be also be provided via:

very_good create my_plugin -t flutter_plugin --desc "My custom description" --org-name com.example.my_plugin

By default, the generated plugin supports all platforms specified above. To disable support for specific platforms use the platform flags:

# Exclude Windows and Linux support
very_good create my_plugin -t flutter_plugin --windows false --linux false

Testing 🧪

Very Good Flutter Plugin ships with 100% code coverage. To learn more about why we believe 100% code coverage is important and other testing best practices read our guide to Flutter testing.

Running Tests 🧑‍🔬

Each platform implementation includes tests which can be run via:

flutter test

Continuous Integration 🤖

Very Good Flutter Plugin comes with a built-in GitHub Actions workflow but you can also add your preferred CI/CD solution.

Out of the box, on each pull request and push, the CI formats, lints, and tests the code using Very Good Workflows. This ensures the code remains consistent and behaves correctly as you add functionality or make changes. The project uses Very Good Analysis for a strict set of analysis options used by our team. Code coverage is enforced using the [Very Good Coverage GitHub Action][very_good_coverage_link].

In addition, there are E2E tests as part of the my_plugin workflow to ensure that the plugin correctly integrates with the host application on each platform.

Comments

build(deps): bump peter-evans/create-pull-request from 4.2.1 to 4.2.2
Bumps peter-evans/create-pull-request from 4.2.1 to 4.2.2.

Release notes

Sourced from peter-evans/create-pull-request's releases.

Create Pull Request v4.2.2

What's Changed

fix: support github server url for pushing to fork by @peter-evans in peter-evans/create-pull-request#1318

New Contributors

@kevinzhu-sa made their first contribution in peter-evans/create-pull-request#1315

Full Changelog: https://github.com/peter-evans/create-pull-request/compare/v4.2.1...v4.2.2

Commits

331d02c fix: support github server url for pushing to fork (#1318)

See full diff in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies github_actions
opened by dependabot[bot] 1
build(deps): bump peter-evans/create-pull-request from 4.1.2 to 4.2.0
Bumps peter-evans/create-pull-request from 4.1.2 to 4.2.0.

Release notes

Sourced from peter-evans/create-pull-request's releases.

Create Pull Request v4.2.0

⚙️ Improves the proxy implementation to properly support the standard environment variables http_proxy, https_proxy and no_proxy

What's Changed

feat: switch proxy implementation by @peter-evans in peter-evans/create-pull-request#1269

Full Changelog: https://github.com/peter-evans/create-pull-request/compare/v4.1.4...v4.2.0

Create Pull Request v4.1.4

⚙️ Bumps @actions/core to transition away from deprecated runner commands.

What's Changed

build(deps): bump @actions/core to 1.10.0 by @peter-evans in peter-evans/create-pull-request#1274

build(deps): bump @actions/exec from 1.1.0 to 1.1.1 by @dependabot in peter-evans/create-pull-request#1279

build(deps): bump @actions/io from 1.1.1 to 1.1.2 by @dependabot in peter-evans/create-pull-request#1280

Full Changelog: https://github.com/peter-evans/create-pull-request/compare/v4.1.3...v4.1.4

Create Pull Request v4.1.3

What's Changed

fix: replace use of any type by @peter-evans in peter-evans/create-pull-request#1251

fix: only strip optional '.git' suffix from https server remote name and not 'Xgit' by @campersau in peter-evans/create-pull-request#1257

Update distribution by @github-actions in peter-evans/create-pull-request#1260

New Contributors

@campersau made their first contribution in peter-evans/create-pull-request#1257

Full Changelog: https://github.com/peter-evans/create-pull-request/compare/v4.1.2...v4.1.3

Commits

b4d5173 feat: switch proxy implementation (#1269)

ad43dcc build(deps): bump @actions/io from 1.1.1 to 1.1.2 (#1280)

c2f9cef build(deps): bump @actions/exec from 1.1.0 to 1.1.1 (#1279)

b67934c ci: update dependabot

ef83023 build(deps): bump @actions/core to 1.10.0 (#1274)

671dc9c build: update distribution (#1260)

ddab646 fix: only strip optional '.git' suffix from https server remote name and not ...

3f9dbd5 fix: replace use of any type (#1251)

See full diff in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies github_actions
opened by dependabot[bot] 1
build(deps): bump peter-evans/create-pull-request from 4.1.2 to 4.1.4
Bumps peter-evans/create-pull-request from 4.1.2 to 4.1.4.

Release notes

Sourced from peter-evans/create-pull-request's releases.

Create Pull Request v4.1.4

⚙️ Bumps @actions/core to transition away from deprecated runner commands.

What's Changed

build(deps): bump @actions/core to 1.10.0 by @peter-evans in peter-evans/create-pull-request#1274

build(deps): bump @actions/exec from 1.1.0 to 1.1.1 by @dependabot in peter-evans/create-pull-request#1279

build(deps): bump @actions/io from 1.1.1 to 1.1.2 by @dependabot in peter-evans/create-pull-request#1280

Full Changelog: https://github.com/peter-evans/create-pull-request/compare/v4.1.3...v4.1.4

Create Pull Request v4.1.3

What's Changed

fix: replace use of any type by @peter-evans in peter-evans/create-pull-request#1251

fix: only strip optional '.git' suffix from https server remote name and not 'Xgit' by @campersau in peter-evans/create-pull-request#1257

Update distribution by @github-actions in peter-evans/create-pull-request#1260

New Contributors

@campersau made their first contribution in peter-evans/create-pull-request#1257

Full Changelog: https://github.com/peter-evans/create-pull-request/compare/v4.1.2...v4.1.3

Commits

ad43dcc build(deps): bump @actions/io from 1.1.1 to 1.1.2 (#1280)

c2f9cef build(deps): bump @actions/exec from 1.1.0 to 1.1.1 (#1279)

b67934c ci: update dependabot

ef83023 build(deps): bump @actions/core to 1.10.0 (#1274)

671dc9c build: update distribution (#1260)

ddab646 fix: only strip optional '.git' suffix from https server remote name and not ...

3f9dbd5 fix: replace use of any type (#1251)

See full diff in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies github_actions
opened by dependabot[bot] 1
build(deps): bump peter-evans/create-pull-request from 4.1.2 to 4.1.3
Bumps peter-evans/create-pull-request from 4.1.2 to 4.1.3.

Release notes

Sourced from peter-evans/create-pull-request's releases.

Create Pull Request v4.1.3

What's Changed

fix: replace use of any type by @peter-evans in peter-evans/create-pull-request#1251

fix: only strip optional '.git' suffix from https server remote name and not 'Xgit' by @campersau in peter-evans/create-pull-request#1257

Update distribution by @github-actions in peter-evans/create-pull-request#1260

New Contributors

@campersau made their first contribution in peter-evans/create-pull-request#1257

Full Changelog: https://github.com/peter-evans/create-pull-request/compare/v4.1.2...v4.1.3

Commits

671dc9c build: update distribution (#1260)

ddab646 fix: only strip optional '.git' suffix from https server remote name and not ...

3f9dbd5 fix: replace use of any type (#1251)

See full diff in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR

@dependabot recreate will recreate this PR, overwriting any edits that have been made to it

@dependabot merge will merge this PR after your CI passes on it

@dependabot squash and merge will squash and merge this PR after your CI passes on it

@dependabot cancel merge will cancel a previously requested merge and block automerging

@dependabot reopen will reopen this PR if it is closed

@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually

@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)

@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies github_actions
opened by dependabot[bot] 1

build(deps): bump actions/setup-java from 2 to 3

Bumps actions/setup-java from 2 to 3.

Release notes

Sourced from actions/setup-java's releases.

v3.0.0

In scope of this release we changed version of the runtime Node.js for the setup-java action and updated package-lock.json file to v2.

Breaking Changes

With the update to Node 16 in #290, all scripts will now be run with Node 16 rather than Node 12.

v2.5.0

In scope of this pull request we add support for Microsoft Build of OpenJDK (actions/setup-java#252).
steps:
  - name: Checkout
    uses: actions/checkout@v2
  - name: Setup-java
    uses: actions/setup-java@v2
    with:
      distribution: microsoft
      java-version: 11
Supported distributions

Currently, the following distributions are supported:

Keyword Distribution Official site License

temurin Eclipse Temurin Link Link

zulu Zulu OpenJDK Link Link

adopt or adopt-hotspot Adopt OpenJDK Hotspot Link Link

adopt-openj9 Adopt OpenJDK OpenJ9 Link Link

liberica Liberica JDK Link Link

microsoft Microsoft Build of OpenJDK Link Link

v2.4.0

In scope of this pull request we add support for Liberica JDK (actions/setup-java#225).
steps:
  - name: Checkout
    uses: actions/checkout@v2
  - name: Setup-java
    uses: actions/setup-java@v2
    with:
      distribution: liberica
      java-version: 11
Supported distributions

Currently, the following distributions are supported:

Keyword Distribution Official site License

zulu Zulu OpenJDK Link Link

adopt or adopt-hotspot Adopt OpenJDK Hotspot Link Link

adopt-openj9 Adopt OpenJDK OpenJ9 Link Link

temurin Eclipse Temurin Link Link

Keyword	Distribution	Official site	License
`temurin`	Eclipse Temurin	Link	Link
`zulu`	Zulu OpenJDK	Link	Link
`adopt` or `adopt-hotspot`	Adopt OpenJDK Hotspot	Link	Link
`adopt-openj9`	Adopt OpenJDK OpenJ9	Link	Link
`liberica`	Liberica JDK	Link	Link
`microsoft`	Microsoft Build of OpenJDK	Link	Link

Keyword	Distribution	Official site	License
`zulu`	Zulu OpenJDK	Link	Link
`adopt` or `adopt-hotspot`	Adopt OpenJDK Hotspot	Link	Link
`adopt-openj9`	Adopt OpenJDK OpenJ9	Link	Link
`temurin`	Eclipse Temurin	Link	Link

... (truncated)

Commits

d854b6d Add support for multiple jdks (#368)
749e449 Add Cache Hit Output (#373)
aa53851 Update actions version in package json (#377)
5b36705 Merge pull request #364 from e-korolevskii/main
4656cbc Merge branch 'actions:main' into main
ef96bec Merge pull request #274 from schuenadel/include-buildSrc-in-cache-key
8e8bf44 Update docs/contributors.md
40dd195 rephased documents
858120d formating
ad9cecf update contributors guide
Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

@dependabot rebase will rebase this PR
@dependabot recreate will recreate this PR, overwriting any edits that have been made to it
@dependabot merge will merge this PR after your CI passes on it
@dependabot squash and merge will squash and merge this PR after your CI passes on it
@dependabot cancel merge will cancel a previously requested merge and block automerging
@dependabot reopen will reopen this PR if it is closed
@dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
@dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
@dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

dependencies github_actions

opened by dependabot[bot] 1

fix: constant case on windows and linux h sources
Description

Some generated sources are leaking the "MY_PLUGIN" section from the template. Added support to replace it with {{project_name.constantCase()}} .

Type of Change

[ ] ✨ New feature (non-breaking change which adds functionality)

[x] 🛠️ Bug fix (non-breaking change which fixes an issue)

[ ] ❌ Breaking change (fix or feature that would cause existing functionality to change)

[ ] 🧹 Code refactor

[ ] ✅ Build configuration change

[ ] 📝 Documentation

[ ] 🗑️ Chore
opened by renancaraujo 1
chore: v0.2.1
Description

chore: v0.2.1

Type of Change

[ ] ✨ New feature (non-breaking change which adds functionality)

[ ] 🛠️ Bug fix (non-breaking change which fixes an issue)

[ ] ❌ Breaking change (fix or feature that would cause existing functionality to change)

[ ] 🧹 Code refactor

[ ] ✅ Build configuration change

[ ] 📝 Documentation

[X] 🗑️ Chore
opened by felangel 0
feat: add ci concurrency group to workflow
Description

feat: add ci concurrency group to workflow

Type of Change

[X] ✨ New feature (non-breaking change which adds functionality)

[ ] 🛠️ Bug fix (non-breaking change which fixes an issue)

[ ] ❌ Breaking change (fix or feature that would cause existing functionality to change)

[ ] 🧹 Code refactor

[ ] ✅ Build configuration change

[ ] 📝 Documentation

[ ] 🗑️ Chore

enhancement
opened by felangel 0
chore: v0.2.0
Description

chore: v0.2.0

Type of Change

[ ] ✨ New feature (non-breaking change which adds functionality)

[ ] 🛠️ Bug fix (non-breaking change which fixes an issue)

[ ] ❌ Breaking change (fix or feature that would cause existing functionality to change)

[ ] 🧹 Code refactor

[ ] ✅ Build configuration change

[ ] 📝 Documentation

[X] 🗑️ Chore
opened by felangel 0
chore: v0.1.2
Description

chore: v0.1.2

Type of Change

[ ] ✨ New feature (non-breaking change which adds functionality)

[ ] 🛠️ Bug fix (non-breaking change which fixes an issue)

[ ] ❌ Breaking change (fix or feature that would cause existing functionality to change)

[ ] 🧹 Code refactor

[ ] ✅ Build configuration change

[ ] 📝 Documentation

[X] 🗑️ Chore
opened by felangel 0
docs: remove copyright header and license from generated code
Description

docs: remove copyright header and license from generated code

Type of Change

[ ] ✨ New feature (non-breaking change which adds functionality)

[ ] 🛠️ Bug fix (non-breaking change which fixes an issue)

[ ] ❌ Breaking change (fix or feature that would cause existing functionality to change)

[ ] 🧹 Code refactor

[ ] ✅ Build configuration change

[X] 📝 Documentation

[ ] 🗑️ Chore

documentation
opened by felangel 0
tests: add native unit tests and lint integration

As a developer, I'd like to have native unit tests for the platform-specific code in addition to the integration tests so that I have a reference for how to write native tests when building out a real-world plugin. Also, native lint integration.
tests

opened by felangel 0
feat: swift support for iOS and macOS plugin

Description

I'd like to request for Swift support being enabled out of the box for iOS and macOS plugin.

Expected Behavior I tend to convert the plugin to use Swift every time I use it and I figured it would be convenient to have it like that from the start.

Screenshots

Default files are Obj-C
bug

opened by orestesgaolin 0

Releases(v0.2.1)

v0.2.1(Dec 7, 2022)
fix: windows path resolution

feat: add ci concurrency group to workflow

Source code(tar.gz)
Source code(zip)
v0.2.0(Dec 6, 2022)
BREAKING feat: add publishable flag (defaults to false)

Source code(tar.gz)
Source code(zip)
v0.1.2(Dec 2, 2022)
docs: remove copyright header and license from generated code

Source code(tar.gz)
Source code(zip)
v0.1.1(Sep 28, 2022)
feat: upgrade to Flutter 3.3.2

feat: upgrade to very_good_analysis 3.1.0

Source code(tar.gz)
Source code(zip)
v0.1.0+1(Sep 13, 2022)
docs: minor README updates

add dependabot integration

fix broken link to very_good_analysis

Source code(tar.gz)
Source code(zip)
v0.1.0(Sep 13, 2022)
feat: upgrade to Flutter 3.3.1

feat: upgrade to very_good_analysis 3.0.2

fix: dependabot integration

Source code(tar.gz)
Source code(zip)
v0.0.1+1(Aug 23, 2022)
chore: remove duplicate images from README

Source code(tar.gz)
Source code(zip)
v0.0.1(Aug 23, 2022)
feat: initial release 🎉

Source code(tar.gz)
Source code(zip)