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

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

$ dart pub add --dev flutterando_metrics

# or for a Flutter package
$ flutter pub add --dev flutterando_metrics

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.

analyzer:
  plugins:
    - flutterando_metrics

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

The package can be used as CLI and supports multiple commands:

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.

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

It will produce a result in one of the format:

• Console
• GitHub
• Codeclimate
• HTML
• JSON

Console report example:

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

It will produce a result in one of the format:

• Console
• JSON

Console report example:

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

It will produce a result in one of the format:

• Console
• JSON

Console report example:

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,
    );
  }
}

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

It will produce a result in one of the format:

• Console
• JSON

Console report example:

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

It will produce a result in one of the format:

• Console
• JSON

Console report example:

Please read the following guide if the plugin is not working as you'd expect it to work.

If you are interested in contributing, please check out the contribution guidelines. Feedback and contributions are welcome!

MIT