dart_code_metrics 2.4.0
dart_code_metrics: ^2.4.0 copied to clipboard

Dart native
Flutter Android iOS Linux macOS Windows

Software analytics tool that helps developers analyse and improve software quality.

example/example.dart

import 'package:dart_code_metrics/metrics_analyzer.dart';
import 'package:dart_code_metrics/reporters.dart';

void main() {
  // Get some folder you would like to analyze
  const foldersToAnalyze = ['lib', 'test'];
  // Root folder path is used to resolve relative file paths
  const rootFolder = 'projectRoot';

  // Store keeps reported issues in format-agnostic way
  final store = MetricsRecordsStore.store();

  // Analyzer traverses files and report its findings to passed store
  final analyzer = MetricsAnalyzer(store);

  // Runner coordinates analyzer and store
  final runner = MetricsAnalysisRunner(analyzer, store, foldersToAnalyze,
      rootFolder: rootFolder);

  // Execute run() to analyze files and collect results
  runner.run();

  // Now runner.results() contains some insights about analyzed code. Let's report it!
  // For a simple example we would report results to terminal

  // First of all config has to be created for a reporter
  const reporterConfig = Config(
      cyclomaticComplexityWarningLevel: 10,
      linesOfExecutableCodeWarningLevel: 50,
      numberOfArgumentsWarningLevel: 4);

  // Now the reporter itself
  final reporter = ConsoleReporter(reportConfig: reporterConfig);

  // Now pass collected analysis reports from runner to reporter and that's it
  reporter.report(runner.results()).forEach(print);

  // There is also JsonReporter for making machine-readable reports
  // HtmlReporter produces fancy html-documents with bells and whistles
  // And CodeClimateReporter produces reports that are widely understood by various CI tools
  // If none of these fits your case you can always access raw analysis info via results() method of runner and process it any way you see fit
}