test: check the validator's rules against the reference table

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

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
48/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
dart, flutter
Domain
testing

Research direction

Compare the Dependency rules table in references/ffca/project_structure.md with the rules map in scripts/validate_layers.dart, noting the known shared mismatch. Study the existing tests in scripts/test/validate_layers_test.dart and the sync_reference.dart --check drift check for the pattern to follow. Done when a test parses the table, fails on drift, and handles the shared row either by waiting for VGVentures/very_good_engineering#292 or by documenting it as a known difference.

Written by the indexing model from the issue text.

Description

test

Description

The Dependency rules section of references/ffca/project_structure.md says its table "is the whole rule, and it is the version a validation script implements". Nothing checks that the rules map at the top of scripts/validate_layers.dart actually matches that table, so the two can drift apart without anyone noticing.

They already disagree: the table says shared may depend on "external packages only", while the validator allows shared → shared. We believe the reference should change, and that is tracked in Very Good Engineering: VGVentures/very_good_engineering#292.

Requirements

  • A test in scripts/test/validate_layers_test.dart parses the Dependency rules table from references/ffca/project_structure.md and checks it against the validator's rules map.
  • When the table changes upstream and is re-synced, the test fails until the validator is updated.
  • The test lands after the reference is re-synced with VGVentures/very_good_engineering#293, which allows shared → shared and is merged, so no known-difference exception is needed.
  • All CI/CD checks are passing.
  • There is no drop in the test coverage percentage.

Additional Context

This is the drift check sync_reference.dart --check already does for the reference mirror, applied to the validator itself.

Status (2026-10-20): VGVentures/very_good_engineering#293 is merged, but the VGV Engineering site has not redeployed yet. Once the site deploys, run dart run scripts/sync_reference.dart (which also brings in VGVentures/very_good_engineering#297's lib/src/ and data barrel changes), then add this test.

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.