flutterando_metrics

Description:

flutterando metrics

Flutterando Metrics #
Note: you can find the full documentation on the website
Configuration |
Metrics |
Anti-patterns
Flutterando Metrics is a toolkit that helps you identify and fix problems in your Dart and Flutter code. These problems can range from potential runtime bugs and violations of best practices to styling issues. Flutterando Metrics includes over 70 built-in rules to validate your code against various expectations, and you can customize these rules to fit your specific needs.

Reports code metrics
Checks for anti-patterns
Checks unused *.dart files
Checks unused l10n
Checks unnecessary nullable parameters
Can be used as CLI

Links #

See CHANGELOG.md for major/breaking updates, and releases for a detailed version history.
To contribute, please read CONTRIBUTING.md first.
Please open an issue if anything is missing or unclear in this documentation.

Installation #
$ dart pub add --dev flutterando_metrics

# or for a Flutter package
$ flutter pub add --dev flutterando_metrics
copied to clipboard
Basic configuration #
Add configuration to analysis_options.yaml and reload IDE to allow the analyzer to discover the plugin config.
You can read more about the configuration on the website.
Basic config #
analyzer:
plugins:
- flutterando_metrics

flutterando_metrics:
metrics:
cyclomatic-complexity: 20
number-of-parameters: 4
maximum-nesting-level: 5
metrics-exclude:
- test/**

copied to clipboard
Usage #
CLI #
The package can be used as CLI and supports multiple commands:



Command
Example of use
Short description




analyze
dart run flutterando_metrics:metrics analyze lib
Reports code metrics anti-patterns violations.


check-unnecessary-nullable
dart run flutterando_metrics:metrics check-unnecessary-nullable lib
Checks unnecessary nullable parameters in functions, methods, constructors.


check-unused-files
dart run flutterando_metrics:metrics check-unused-files lib
Checks unused *.dart files.


check-unused-l10n
dart run flutterando_metrics:metrics check-unused-l10n lib
Check unused localization in *.dart files.


check-unused-code
dart run flutterando_metrics:metrics check-unused-code lib
Checks unused code in *.dart files.



For additional help on any of the commands, enter dart run flutterando_metrics:metrics help <command>
Note: if you're setting up Flutterando Metrics for multi-package repository, check out this website section.
Analyze
Reports code metrics and anti-patterns violations. To execute the command, run
$ dart run flutterando_metrics:metrics analyze lib

# or for a Flutter package
$ flutter pub run flutterando_metrics:metrics analyze lib
copied to clipboard
It will produce a result in one of the format:

Console
GitHub
Codeclimate
HTML
JSON

Console report example:

Check unnecessary nullable parameters
Checks unnecessary nullable parameters in functions, methods, constructors. To execute the command, run
$ dart run flutterando_metrics:metrics check-unnecessary-nullable lib

# or for a Flutter package
$ flutter pub run flutterando_metrics:metrics check-unnecessary-nullable lib
copied to clipboard
It will produce a result in one of the format:

Console
JSON

Console report example:

Check unused files
Checks unused *.dart files. To execute the command, run
$ dart run flutterando_metrics:metrics check-unused-files lib

# or for a Flutter package
$ flutter pub run flutterando_metrics:metrics check-unused-files lib
copied to clipboard
It will produce a result in one of the format:

Console
JSON

Console report example:

Check unused localization
Checks unused Dart class members, that encapsulates the app’s localized values.
An example of such class:
class ClassWithLocalization {
String get title {
return Intl.message(
'Hello World',
name: 'title',
desc: 'Title for the Demo application',
locale: localeName,
);
}
}
copied to clipboard
To execute the command, run
$ dart run flutterando_metrics:metrics check-unused-l10n lib

# or for a Flutter package
$ flutter pub run flutterando_metrics:metrics check-unused-l10n lib
copied to clipboard
It will produce a result in one of the format:

Console
JSON

Console report example:

Check unused code
Checks unused code in *.dart files. To execute the command, run
$ dart run flutterando_metrics:metrics check-unused-code lib

# or for a Flutter package
$ flutter pub run flutterando_metrics:metrics check-unused-code lib
copied to clipboard
It will produce a result in one of the format:

Console
JSON

Console report example:

Troubleshooting #
Please read the following guide if the plugin is not working as you'd expect it to work.
Contributing #
If you are interested in contributing, please check out the contribution guidelines. Feedback and contributions are welcome!
LICENSE #
MIT