Skip to content

README.md

Latest commit

 

History

History
98 lines (77 loc) · 2.39 KB

README.md

File metadata and controls

98 lines (77 loc) · 2.39 KB

grumpy_context

grumpy_context analyzes a Dart or Flutter project and returns typed context data that bricks and custom lints can consume.

What it returns

  • Project name from pubspec.yaml
  • Direct dependency declarations grouped by scope
  • Discovered modules and their layer inventories
  • Diagnostics for missing, partial, or ambiguous structure
  • The resolved discovery config that was applied

Usage

import 'package:grumpy_context/grumpy_context.dart';

Future<void> main() async {
  final context = await analyzeProject('/path/to/project');

  print(context.name);
  print(context.modules.map((module) => module.name).toList());
}

grumpy.yaml

The analyzer looks for an optional root-level grumpy.yaml. If it is missing, built-in defaults are used.

# yaml-language-server: $schema=https://raw.githubusercontent.com/necodeIT/grumpy_context/refs/heads/main/grumpy.schema.json
module_roots:
  - lib
  - lib/src

barrel_file_patterns:
  - "{folder}.dart"
  - "*.exports.dart"

layers:
  utils:
    - utils
  domain:
    models:
      - domain/models
    services:
      - domain/services
    datasources:
      - domain/datasources
  infra:
    services:
      - infra/services
    datasources:
      - infra/datasources
  presentation:
    components:
      - presentation/components
    screens:
      - presentation/screens
    repos:
      - presentation/repos
    middleware:
      - presentation/middleware
      - presentation/guards

defaults:
  model:
    fields:
      id:
        type: String
      displayName:
        type: String
        nullable: true
        default: "'guest'"

The output schema is fixed. grumpy.yaml only changes how the project is discovered.

Barrel files are hidden from bucket inventories by default. Patterns are matched against the file basename only, and {folder} expands to the immediate parent folder name. If filtering removes every file in a bucket, the bucket still exists and its directoryPath is preserved while files becomes empty.

Logging

The package emits structured logs through package:logging using logger names under grumpy_context.*, for example:

  • grumpy_context.analyzer
  • grumpy_context.config
  • grumpy_context.pubspec
  • grumpy_context.scanner
  • grumpy_context.diagnostics

No log handlers are installed by default.

Schema

A JSON schema for grumpy.yaml is provided at grumpy.schema.json.