dartrics

https://pub.dev/packages/dartrics
Admin
Dart code-quality metrics and unused public-API detection, designed as the AI-loop counterpart of...
Tokens:12,494
Snippets:168
Trust Score:9.9
Update:4 months ago
Show doc for...
Tokens:
Raw
### Quick Start Examples

Source: https://pub.dev/packages/dartrics

Examples demonstrating common dartrics commands for analysis, regression testing, and accessing documentation.

```bash
# Token-efficient YAML-ish report optimised for LLM consumption.
dartrics analyze lib/ --reporter ai | claude -p "Refactor the threshold violations"

```

```bash
# After the agent applies a fix: confirm metrics actually improved.
dartrics regression --before HEAD~1 --after HEAD --reporter ai

```

```bash
# Read the operational playbook (start here) or the lens reference in the terminal.
dartrics ai-loop
dartrics manual

```

--------------------------------

### Install dartrics as an Executable

Source: https://pub.dev/packages/dartrics/install

Activate the dartrics package globally from the command line to use it as an executable tool.

```bash
dart pub global activate dartrics
```

--------------------------------

### Install Dartrics Globally

Source: https://pub.dev/packages/dartrics/versions/0.8.0

Activate the dartrics package globally using the Dart pub tool. This makes the dartrics command-line tool available system-wide.

```bash
dart pub global activate dartrics

```

--------------------------------

### Dartrics Configuration Example

Source: https://pub.dev/packages/dartrics/versions/0.8.0

Minimal analysis_options.yaml configuration for Dartrics, including metric thresholds and exclusions. The yaml-language-server directive enables autocomplete and typo detection.

```yaml
# yaml-language-server: $schema=https://raw.githubusercontent.com/koji-1009/dartrics/main/schemas/dartrics-config.schema.json

dartrics:
  metrics:
    cyclomatic-complexity:
      warning: 10
      error: 20
    cognitive-complexity:
      warning: 15
  exclude:
    - "lib/generated/**"

```

--------------------------------

### Access Dartrics Operational Playbook and Reference

Source: https://pub.dev/packages/dartrics/versions/0.8.0

View the operational playbook for AI agents or the conceptual reference guide directly in the terminal. These commands provide essential information for using dartrics effectively.

```bash
# Read the operational playbook (start here) or the lens reference in the terminal.
dartrics ai-loop
dartrics manual

```

--------------------------------

### Dartrics Analyzer Plugin Setup

Source: https://pub.dev/packages/dartrics/versions/0.8.0

Configuration for enabling the Dartrics analyzer plugin in your project's analysis_options.yaml. After saving, restart the analysis server for the rules to take effect.

```yaml
# analysis_options.yaml in your project
plugins:
  dartrics:


```

--------------------------------

### Development Commands for Dartrics

Source: https://pub.dev/packages/dartrics/versions/0.8.0

These commands are used to manage dependencies, format code, analyze the project, run tests, and generate code coverage reports.

```bash
dart pub get
dart format lib test example
dart analyze lib test example   # `dart analyze` (no path) loads the plugin isolate and may flake
dart test
dart pub run coverage:test_with_coverage  # 100% line coverage is required
```

--------------------------------

### Analyze Code with Dartrics for AI Consumption

Source: https://pub.dev/packages/dartrics/versions/0.8.0

Analyze the 'lib/' directory and pipe the token-efficient YAML-ish report to an AI model for refactoring. This is the primary command for AI-driven code improvement.

```bash
# Token-efficient YAML-ish report optimised for LLM consumption.
dartrics analyze lib/ --reporter ai | claude -p "Refactor the threshold violations"

```

--------------------------------

### MIT License Text

Source: https://pub.dev/packages/dartrics/license

The full text of the MIT License, including copyright notice and permission terms.

```text
MIT License

Copyright (c) 2026 Koji Wakamiya

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

```

--------------------------------

### Verify Code Improvements After AI Refactoring

Source: https://pub.dev/packages/dartrics/versions/0.8.0

Compare code metrics between two Git commits to confirm that AI-applied fixes have actually improved the code quality. Use the 'ai' reporter for LLM consumption.

```bash
# After the agent applies a fix: confirm metrics actually improved.
dartrics regression --before HEAD~1 --after HEAD --reporter ai

```

--------------------------------

### Add dartrics as a Dependency (Dart)

Source: https://pub.dev/packages/dartrics/install

Add the dartrics package as a dependency to your Dart project using the dart pub add command.

```bash
$ dart pub add dartrics
```

--------------------------------

### Add dartrics as a Dependency (Flutter)

Source: https://pub.dev/packages/dartrics/install

Add the dartrics package as a dependency to your Flutter project using the flutter pub add command.

```bash
$ flutter pub add dartrics
```

--------------------------------

### Import dartrics in Dart Code

Source: https://pub.dev/packages/dartrics/install

Import the dartrics package into your Dart files to use its functionalities.

```dart
import 'package:dartrics/dartrics.dart';
```

--------------------------------

### Compute Single Function Metric Programmatically

Source: https://pub.dev/packages/dartrics/example

This snippet demonstrates how to programmatically compute a single metric, Cyclomatic Complexity, for a given Dart function using the dartrics library. It's useful for custom tooling like CI bots or editor extensions.

```dart
// Minimal example: compute a single function metric on inline source.
//
// Most users will run `dartrics analyze .` from the command line. This
// file shows how to drive an individual metric calculator from Dart for
// custom tooling — e.g. building a CI bot or an editor extension.

import 'package:analyzer/dart/analysis/utilities.dart';
import 'package:analyzer/dart/ast/ast.dart';
import 'package:dartrics/dartrics.dart';

void main() {
  const source = '''
int classify(int x, int y) {
  if (x > 0 && y > 0) return 1;
  if (x < 0 || y < 0) return -1;
  return 0;
}
''';

  final unit = parseString(content: source).unit;
  final declaration = unit.declarations.whereType<FunctionDeclaration>().single;
  final input = FunctionMetricInput(
    context: (
      unit: unit,
      source: source,
      lineInfo: parseString(content: source).lineInfo,
    ),
    declaration: declaration,
  );

  // Each metric ships its own short rationale and a list of refactor hints
  // — `dartrics rules` emits them for the whole catalogue.
  const cc = CyclomaticComplexity();
  print('${cc.id} = ${cc.compute(input)}');
  print('rationale: ${cc.rationale}');
  print('refactor hints:');
  for (final hint in cc.refactorHints) {
    print('- $hint');
  }
  print('dartrics version: $dartricsVersion');
}

```
Tokens:
Raw