feat: add type-level ownership checks to the layer validator

Open
#28 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
22/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
dart, flutter
Domain
tooling

Research direction

Start with the ffca-layer-auditor agent and domain.md, which define the ownership rules and the Summary pattern. The issue is blocked by #22 (moving the validator into Very Good CLI) and uses severity levels from #21, so confirm both are merged before building on them. Done means three rules (data implementing another feature's domain interface as an error, domain interfaces using another feature's models as a warning, and domain public APIs importing dart:ui, Flutter, or backend types as an error), each with fixtures and tests, and the agent consuming these results.

Written by the indexing model from the issue text.

Description

feature

Description

Some ownership rules can only be checked by looking at types, not at pubspecs or import directives. The ffca-layer-auditor agent covers them with an LLM today.

The validator stays a dependency-free script in this plugin: moving it into Very Good CLI was decided against. package:analyzer is therefore not available, since it would need dart pub get in scripts/ before the hook could run. These checks have to work from source text, the way the import checks from #25 do: read class … implements … declarations and repository method signatures, and resolve type names through the file's imports. A rule that cannot be checked reliably that way stays with the auditor.

Requirements

  • Error: a class in {f}_data implements a repository interface from another feature's _domain. The dependency on that domain is allowed, but the data layer implements only its own domain's interfaces.
  • Warning: a repository interface in {f}_domain takes or returns a model from another feature's _domain. This is what the Summary pattern in domain.md avoids. Sometimes legitimate, hence a warning (#21).
  • Error: {f}_domain uses dart:ui, Flutter types, or backend types (Firebase, HTTP clients) in its public API. The domain layer is pure Dart (domain.md).
  • Each check works from source text with no new dependencies. A rule that would need full type resolution to avoid false positives stays with the auditor, and the issue says which.
  • Fixtures and tests for each rule.
  • The ffca-layer-auditor agent relies on these results instead of checking the same rules itself.
  • All CI/CD checks are passing.
  • There is no drop in the test coverage percentage.

Additional Context

Uses the severity levels from #21 and the directive scanner from #31.

Dominant language
Dart
Stars
7
Forks
2
Avg merge
9h 59m
Merged PRs (30d)
7

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from VeryGoodOpenSource/vgv-ffca-plugin

All issues in VeryGoodOpenSource/vgv-ffca-plugin

Similar issues

More Dart issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.