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

オープン
#23 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
48/100
issue の種類
機能追加
明瞭さ
おおむね明確
活発さ
活発
技術スタック
dart, flutter
領域
testing

調査の方向性

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.

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
Dart
スター
7
フォーク
2
平均マージ
2日 8時間
マージ済み PR(30日)
9

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

VeryGoodOpenSource/vgv-ffca-plugin のほかの issue

VeryGoodOpenSource/vgv-ffca-plugin の issue をすべて見る

似ている issue

Dart の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。