Project

flutter_rb

0.0
The project is in a healthy, maintained state
flutter_rbflutter-rb/flutter-rbHomepageDocumentationSource CodeBug TrackerWiki
CLI tool for checking a Flutter plugin structure
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
4,589
Stars
2
Forks
1
Watchers
2
 Releases
Current version
1.2.3
Total releases
11
First release
2022-06-26
Latest release
2024-07-20
 Issues
Open Issues
0
Closed Issues
9
Total Issues
9
Issue Closure Rate
100%
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
1
Merged Pull Requests
58
Pull Request Acceptance Rate
98%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2024-04-20
Reverse Dependencies
0

 Dependencies

Development

rdoc
= 6.6.2
minitest
= 5.14.0
rake
= 12.3.3
rubocop
= 1.7
simplecov
= 0.22.0

Runtime

cocoapods
= 1.10.0
colorize
= 0.8.1
nokogiri
= 1.13.9
dry-cli
= 1.0.0
 Project Readme

Project's logo

flutter_rb

GitHubActions Codebeat Gem Version Gem Downloads

About

CLI tool for checking a Flutter plugin structure.

Checks

Levels

Each issue has a level parameter that describes its significant importance.

Level Description
NORMAL Issue not found
WARNING Issue is not serious and can't break a build
ERROR Issue is critical and can break a build

Flutter

Check Description Level
PluginDirectoriesCheck Check plugin directories structure in pubspec file. Example: if a Flutter plugin has only Android specific code but not contains iOS folder with description, then iOS build fails ERROR
PluginPubspecNameCheck Check plugin name in pubspec file. Exists or not ERROR
PluginPubspecDescriptionCheck Check plugin description in pubspec file. Exists or not WARNING
PluginPubspecVersionCheck Check plugin version in pubspec. Exists or not ERROR
PluginPubspecAuthorCheck Check plugin author in pubspec. Exists or not. author section deprecated in pubspec.yaml WARNING
PluginPubspecHomepageCheck Check plugin homepage in pubspec. Exists or not ERROR
PluginPubspecLintsCheck Check Flutter plugin lints dependency in pubspec file. Exists or not ERROR
PluginPubspecFlutterLintsCheck Check Flutter plugin flutter_lints dependency in pubspec file. Exists or not ERROR

Android

Check Description Level
PluginGradleAndroidPackageCheck Validate that \android\ package not exists in Gradle project config (build.gradle file) ERROR
PluginGradleVersionCheck Check plugin version in Gradle project config (build.gradle file). Version must be the same as plugin version in pubspec file WARNING

iOS

Check Description Level
PluginPodspecNameCheck Check plugin name in podspec file. Exists or not WARNING
PluginPodspecVersionCheck Check plugin version in podspec file. Exists or not WARNING
PluginPodspecAuthorsCheck Check plugin's authors in podspec file. Exists or not ERROR
PluginPodspecSourceCheck Check plugin iOS source path in podspec file. If Flutter plugin cannot contains iOS specific code, source path must be '.' ERROR

How to use

Android

You should add flutter-rb-gradle-plugin to Android side of your plugin.

Download gem from RubyGems

$ gem i flutter_rb

Then run from a Flutter plugin's project folder:

$ frb

As local installed gem

Build and install gem from sources:

$ gem build flutter_rb.gemspec
$ gem i flutter_rb

Then run from a Flutter plugin's project folder:

$ frb inspect --path=./project_folder

As local executable

Add project_folder/bin (where project_folder is path to project on your machine) to PATH variable in your environment. Then updated environment and run from a Flutter plugin's project folder:

$ local_frb inspect --path=./project_folder

Commands

Inspect

Starts the flutter-rb.

$ frb inspect --path=./project_folder --report
Argument Description
--path Path to Dart/Flutter project. flutter-rb will be use current directory if this parameter are empty
--report Generate report in Checkstyle format

Version

Puts using version of flutter-rb.

$ frb version

Author

Puts author and our contacts.

$ frb author

Configuration

CLI

Since version 1.2.2 you can generate config by following command in terminal:

$ frb config

Manually

Add .flutter_rb.yaml to root of a project for select checks that you are want to exclude:

exclude:
  flutter:
    - PluginDirectoriesCheck
    - PluginPubspecNameCheck
    - PluginPubspecDescriptionCheck
  android:
    - PluginGradleAndroidPackageCheck
  ios:
    - PluginPodspecNameCheck
    - PluginPodspecVersionCheck
    - PluginPodspecAuthorsCheck

Output report

Tool can make report in Checkstyle format. To enable this feature, pass --checkstyle-report as an CLI argument. The report file name is frb-checkstyle-report.xml.

How to contribute

Documentation

Just run:

$ rdoc

Contribution

Read Commit Convention. Make sure your build is green before you contribute your pull request. Then:

$ bundle exec rake

If you don't see any error messages, submit your pull request.

Contributors